|
|
|
软件工程的文档标准包含三个，分别是《GB/T 16680—1996软件文档管理指南》《GB/T 8567—2006计算机软件文档编制规范》和《GB/T 9385—2008计算机软件需求说明编制指南》。下面对这三个标准分别进行说明。
|
|
|
|
|
|
该标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。下面以列表形式说明软件文档管理的重点内容、软件文档种类以及软件文档的四个级别。
|
|
|
|
软件文档可区分为开发文档、产品文档和管理文档三类文档，下表描述了三类文档的定义、作用以及种类。
|
|
|
|
|
|
|
|
根据软件文档质量要求，可以将软件文档的重要性划分为四个等级，参见下表。
|
|
|
|
|
|
|
|
|
|
《GB/T 8567—2006计算机软件文档编制规范》给出了软件项目开发过程中典型的文件的编制指导。
|
|
|
|
软件开发文件编制指南以提供模板的方式提供了软件开发过程中所需的25种文档以及面向对象开发所对应的10种文档。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
（9）系统（子系统）设计（结构设计）说明（SSDD）。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
一份正确、完整的软件需求说明编制指南（SRS）能带来以下好处：
|
|
|
|
.对于提供什么软件产品，为顾客和供方之间的协议建立基础。
|
|
|
|
.减少开发工作，SRS文档的编制迫使各方人员在设计之前严格考虑所有的需求，并减少以后的重新设计、重新编码和重新测试。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.外部接口：软件如何与人、系统的硬件及其他硬件和其他软件进行交互。
|
|
|
|
|
|
.属性：软件的可用性、可靠性、可移植性、正确性、可维护性、安全性如何。
|
|
|
|
.影响产品实现的设计约束：是否有使用标准、编程语言、数据库完整性方针、资源限制、运行环境等方面的要求。
|
|
|
|
SRS编写人员应避免把设计或项目管理需求写入SRS中。好的SRS具有如下特征：
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
 目的
|
|
|
|
范围
|
|
|
|
定义、简写和缩略语
|
|
|
|
引用文件
|
|
|
|
综述
|
|
|
|
|
|
产品描述
|
|
|
|
产品功能
|
|
|
|
用户特点
|
|
|
|
约束
|
|
|
|
假设和依赖关系
|
|
|
|
需求分配
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
