软件开发规范.doc

项目组软件开发行为规范仅供信息化部使用1  概述  编写目的 为了把公司已经发布的软件开发过程规范有效地运作于产品开发活动中,把各种规范“逐步形成工程师的作业规范”,特制定本软件开发行为规范,以到达提高系统质量的目的。在本规范中,阐述了基本的开发模式,包括需求验证、设计、编码规范、代码审查、单元测试、配置管理等,并明确开发过程中的方法、策略、工具以及环境要求,开发人员都必须遵守本软件开发规范。 读者对象 本规范读者对象为软件开发项目管理者、项目经理、,问题暴露越早越好。因此,在实施设计和编码前,需对项目经理提供的需求说明文档进行充分的验证,在不明确的需求点上,需要和项目经理进一步核实,确保对每个需求点有清晰、一致的认识和理解。在需求验证的过程中,需按以下检查点进行逐项检查(包括不限于):所有定义、实现方法是否清楚地表达了用户的原始要求?是否清楚、明确地描述了所有的功能?是否没有不能理解或造成误解的描述 ?需求定义是否包含了有关功能、性能、限制、目标、质量等方面的所有需求? 需求是否可以验证(即是否可以检验软件是否满足了需求)? 是否有术语定义一览表?是否标识并定义了在将来可能会变化的需求? 各个需求之间是否一致?是否有冲突和矛盾? 是否定义了系统所有的输入、输出及其来源?主要为客户或者其他外部接口,是否明确定义了输入参数和输出参数?是否说明了如何进行系统输入的合法性检查?功能性需求是否覆盖了所有非正常情况的处理?对异常数据产生的结果是否作了精确的描述?是否充分定义了关于人机界面的需求? 在不同情况下,是否规定了系统的响应时间? 界面需求是否使软硬件系统具有兼容性? 是否有对相关日志做明确要求?以满足稽核相关的需要。针对开发过程中的需求变更,以上需求验证点同样适用,并同时评估需求变更给当前项目的设计和开发带来的风险,包括架构、安全、进度等方面,以便项目经理进行计划调整和安排。,使用Excel对以上检查点进行跟踪和标记。记录文档需check--in到svn。-in到svn。,并跟踪其状态。,必须保证需要实现的需求规格已经被设计。概要设计文档的需涵盖以下几方面:涵盖系统的总体结构、功能。系统共包含哪些模块,以及模块之间的关系。使阅读者对系统有了全局观。明确系统使用的外部接口和资源。包括外部环境、第三方接口、第三方技术架构等。模块设计的进一步细化,包括具体的输入、输出、处理逻辑、与其他模块之间的接口等。数据结构设计,文档中明确数据的物理结构和逻辑结构,包括数据的存储方式、缓存策略、备份策略、清理策略等。容灾设计,主要指外部资源或接口不可用时,系统如何处理,包括客户提示信息、错误现场记录等。监控设计,针对系统中的关键业务,特别是对实时性、准确性要求较高的功能,需考虑其监控指标、监控方法、业务阀值、告警通知的设计。安全设计,在系统概要设计中,要充分考虑系统安全方面的设计,包括数据传输、数据存储、网络攻击等方面的情况。其他情况,未在以上提及的项目其他情况,可进行特别说明。同时,在概要设计过程中,需遵循以下原则:当需求规格发