|
|
|
GB/T 8567—2006《计算机软件文档编制规范》主要对软件的开发过程和管理过程应编制的主要文档及其编制的内容、格式规定了基本要求。该标准原则上适用于所有类型的软件产品的开发过程和管理过程。
|
|
|
|
GB/T 8567—2006规定了文档过程，包括软件标准的类型（含产品标准和过程标准）、源材料的准备、文档计划、文档开发、评审、与其他公司的文档开发子合同。该标准规定了文档编制要求，包括软件生存同期与各种文档的编制要求，含可行性与计划研究、需求分析、设计、实现、测试、运行与维护共6个阶段的要求，在文档编制中应考虑的各种因素。
|
|
|
|
GB/T 8567—2006详细给出了25种文档编制的格式，包括可行性分析（研究）报告、软件开发计划、软件测试计划、软件安装计划、软件移交计划、运行概念说明、系统／子系统需求规格说明、接口需求规格说明、系统／子系统设计（结构设计）说明、接口设计说明、软件需求规格说明、数据需求说明、软件（结构）设计说明、数据库（顶层）设计说明、软件测试说明、软件测试报告、软件配置管理计划、软件质量保证计划、开发进度月报、项目开发总结报告、软件产品规格说明、软件版本说明、软件用户手册、计算机操作手册、计算机编程手册。这25种文件可分别适用于计算机软件的管理人员、开发人员、维护人员和用户。标准给出了25种文件的具体内容，使用者可根据实际情况对该标准进行适当剪裁。
|
|
|
|
GB8567—2006还规定了面向对象的软件应编制以下文档：总体说明文档、用例图文档、类图文档、顺序图文档、协作图（通信图）文档、状态图文档、活动图文档、构件图文档、部署图文档、包图文档。
|
|
|
|
GB/T 8567—2006参考国际标准ISO/IEC 15910：1999《信息技术软件用户文档过程》等标准制定的，代替GB/T 8567-1988《计算机软件产品开发文件编制指南》。
|
|
|
|
|
|
软件生命周期各阶段与软件文档编制工作的关系如下表所示。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
在一项软件的开发过程中，随着程序的逐步形成和逐步修改，各种文件亦在不断地产生、不断地修改或补充。因此，必须加以周密的控制，以保持文件与程序产品的一致性，保持各种文件之间的一致性和文件的安全性。这种控制表现为：
|
|
|
|
（1）就从事一项软件开发工作的开发集体而言，应设置一位专职的文件管理人员（接口管理工程师或文件管理员）；在开发集体中，应该集中保管本项目现有全部文件的主文本两套，由该文件管理人员负责保管。
|
|
|
|
（2）每一份提交给文件管理人员的文件都必须有编写人、审核人和批准人的签字。
|
|
|
|
（3）这两套主文本的内容必须完全一致。其中有一套是可供出借的，另一套是绝对不能出借的，以免发生万一；可出借的主文本在出借时必须办理出借手续，归还时办理注销出借手续。
|
|
|
|
（4）开发集体中的工作人员可以根据工作的需要，在本项目的开发过程中持有一些文件，即所谓个人文件，包括为使他完成他承担的任务所需要的文件，以及他在完成任务过程中所编制的文件；但这种个人文件必须是主文本的复制品，必须同主文本完全一致，若要修改，必须首先修改主文本。
|
|
|
|
（5）不同开发人员所拥有的个人文件通常是主文本的各种子集；所谓子集是指把主文本的各个部分根据承担不同任务的人员或部门的工作需要加以复制、组装而成的若干个文件的集合；文件管理人员应该列出一份不同子集的分发对象的清单，按照清单及时把文件分发给有关人员或部门。
|
|
|
|
（6）一份文件如果已经被另一份新的文件所代替，则原文件应该被注销；文件管理人中要随时整理主文本，及时反映出文件的变化和增加情况，及时分发文件。
|
|
|
|
（7）当一个项目的开发工作临近结束时，文件管理人员应逐个收回开发集体内每个成员的个人文件，并检查这些个人文件的内容；经验表明，这些个人文件往往可能比主文本更详细，或同主文本的内容有所不同，必须认真监督有关人员进行修改，使主文本能真正反映实际的开发结果。
|
|
|
