作者:iamlaosong
看到很多关于软件开发文档模板的介绍文章,其实早在1988年国家就推出了文档模板的国标,就是GB/T 8567-1988,这个标准目前已被新的版本代替,GB/T 8567最新的版本是2006年发布的【计算机软件文档编制规范】,88年版本的名称和2006年的不一样,叫做【计算机软件产品开发文件编制指南】。现在写文档应以2006年版为主了,GB/T 8567-1988有点过时,但也不是不能用,主要看自己的需要,两个版本还是各有特点的。这两个标准都是推荐标准,就是说可以根据自己的实际情况使用或者进行修改,很多公司和单位都根据国标推出适合自己情况的文档模板。
下面对两个版本的标准做个简单介绍:
标准编号:GB/T 8567-1988 标准名称:计算机软件产品开发文件编制指南 标准状态:作废 英文标题:Guidelines for computer software product development documentation 替代情况:被GB/T 8567-2006代替 实施日期:1988-7-1 颁布部门:国家标准局 内容简介:本指南是一份指导性文件。本指南建议,在一项计算机软件的开发过程中,一般地说,应该产生十四种文件。这十四种文件是:可行性研究报告;项目开发计划;软件需求说明书;数据要求说明书;概要设计说明书;详细设计说明书;数据库设计说明书;用户手册;操作手册;模块开发卷宗;测试计划;测试分析报告;开发进度月报;项目开发总结报告。
标准编号:GB/T 8567-2006 标准名称:计算机软件文档编制规范 标准状态:现行 英文标题:Specification for computer software documentation 替代情况:替代GB/T 8567-1988 实施日期:2006-7-1 颁布部门:中华人民共和国国家质量监督检验检疫总局 中国国家标准化管理委员会 内容简介:本标准对软件的开发过程和管理过程应编制的主要文档及其编制的内容、格式规定了基本要求。本标准原则上适用于所有类型的软件产品的开发过程和管理过程。目录如下:
前言
1 范围
2 规范性引用文件
3 术语和定义
4 缩略语
5 文档过程
5.1 概述
5.2 源材料准备
5.3 文档计划
5.4 文档开发
5.5 评审
5.6 与其他公司的文档开发子合同
6 文档编制要求
6.1 软件生存周期与各种文档的编制
6.2 文档编制中的考虑因素
7 文档编制格式
7.1 可行性分析(研究)报告(FAR)
7.2 软件开发计划(SDP)
7.3 软件测试计划(STP)
7.4 软件安装计划(SIP)
7.5 软件移交计划(STrP)
7.6 运行概念说明(OCD)
7.7 系统/子系统需求规格说明(SSS)
7.8 接口需求规格说明(IRS)
7.9 系统/子系统设计(结构设计)说明(SSDD)
7.10接口设计说明(IDD)
7.11软件需求规格说明(SRS)
7.12数据需求说明(DRD)
7.13软件(结构)设计说明(SDD)
7.14数据库(顶层)设计说明(DBDD)
7.15软件测试说明(STD)
7.16软件测试报告(STR)
7.17软件配置管理计划(SCMP)
7.18软件质量保证计划(SQAP)
7.19开发进度月报(DPMR)
7.20项目开发总结报告(PDSR)
7.21软件产品规格说明(SPS)
7.22软件版本说明(SVD)
7.23软件用户手册(SUM)
7.24计算机操作手册(COM)
7.25计算机编程手册(CPM)
附录A(规范性附录)面向对象软件的文档编制
A.1 综述
A.2 总体说明文档
A.3 用况图文档
A.4 类图文档
A.5 顺序图文档
A.6 协作图文档
A.7 状态图文档
A.8 活动图文档
A.9 构件图文档
A.10部署图文档
A.11包图文档
参考文献
标准的具体内容可以在网上搜索下载,也可以用下面这个链接下载: