软件开发行为规范.pdf
软件开发行为规范是为了提高系统质量而制定的规范,旨在指导软件开发过程中的各个阶段,包括需求验证、设计、编码规范、代码审查、单元测试、配置管理等。该规范适用于软件开发项目管理者、项目经理、开发组等,旨在确保软件开发过程的质量和一致性。
一、概述
软件开发行为规范的编写目的在于将公司已经发布的软件开发过程规范有效地运作于产品开发活动中,并将各种规范“逐步形成工程师的作业规范”。该规范阐述了基本的开发模式,包括需求验证、设计、编码规范、代码审查、单元测试、配置管理等,并明确开发过程中的方法、策略、工具以及环境要求,开发人员都必须遵守本软件开发规范。
二、需求评审
需求评审是软件开发过程中的一 个重要阶段,旨在验证需求是否明确、清晰、可验证。需求评审的过程中,需按以下检查点进行逐项检查:
1. 所有定义、实现方法是否清楚地表达了用户的原始要求?
2. 是否清楚、明确地描述了所有的功能?是否没有不能理解或造成误解的描述?
3. 需求定义是否包含了有关功能、性能、限制、目标、质量等方面的所有需求?
4. 需求是否可以验证(即是否可以检验软件是否满足了需求)?
5. 是否有术语定义一览表?
6. 是否标识并定义了在将来可能会变化的需求?
7. 各个需求之间是否一致?是否有冲突和矛盾?
8. 是否定义了系统所有的输入、输出及其来源?
9. 是否说明了如何进行系统输入的合法性检查?
10. 功能性需求是否覆盖了所有非正常情况的处理?
11. 对异常数据产生的结果是否作了精确的描述?
12. 是否充分定义了关于人机界面的需求?
13. 在不同情况下,是否规定了系统的响应时间?
14. 界面需求是否使软硬件系统具有兼容性?
15. 是否有对相关日志做明确要求?
在需求评审过程中,需使用Excel对以上检查点进行跟踪和标记,并记录文档需check-in到svn。
三、系统设计及评审
系统设计及评审是软件开发过程中的另一个重要阶段,旨在确保系统设计的质量和一致性。系统设计文档需涵盖以下几个方面:
1. 系统的总体结构、功能。
2. 系统使用的外部接口和资源。
3. 模块设计的进一步细化,包括具体的输入、输出、处理逻辑、与其他模块之间的接口等。
4. 数据结构设计,文档中明确数据的物理结构和逻辑结构,包括数据的存储方式、缓存策略、备份策略、清理策略等。
5. 容灾设计,主要指外部资源或接口不可用时,系统如何处理,包括客户提示信息、错误现场记录等。
6. 监控设计,针对系统中的关键业务,特别是对实时性、准确性要求较高的功能,需考虑其监控指标、监控方法、业务阀值、告警通知的设计。
7. 安全设计,在系统概要设计中,要充分考虑系统安全方面的设计,包括数据传输、数据存储、网络攻击等方面的情况。
在系统设计过程中,需遵循以下原则:
1. 当需求规格发生变更时,必须修订相关概要设计文档。
2. 在概要设计文档,必须记录、验证需求和概要设计的跟踪关系。
3. 必须保证概要设计文档和代码的一致性。当发生设计更改时,必须修订相应设计文档。
4. 概要设计过程结束前,必须通过评审,并保存评审记录。
5. 设计更改必须经过相关评审,并保存评审记录。
在概要设计评审阶段,可按以下检查点进行逐项验证:
1. 是否描述了接口的功能特征?
2. 接口是否便于查错?
3. 接口相互之间、和其他模块、和需求说明书及接口规格书保持一致?
通过遵守本软件开发行为规范,软件开发人员可以确保软件开发过程的质量和一致性,从而提高系统质量。