软件开发文档编制规范

软件开发项目中 文档编制及其管理规范

1. 文件种类

计算机软件所包含的文件有2类，一类是开发过程中填写的各种图表，称之为工作表格；另一类是应编制的技术资料或技术管理资料，称为文档。

在一项计算机软件的开发过程中，一般地说，应该产生14种文件：

- - - - - - - - - - - - - -

可行性研究报告 项目开发计划 软件需求说明书 数据要求说明书 概要设计说明书 详细设计说明书 数据库设计说明书 用户手册 操作手册 模块开发卷宗 测试计划 测试分析报告 开发进度月报 项目开发总结报告

2. 使用文件的人员以及所关心的文件：

人员 管理人员

文件种类

可行性研究报告 模块开发卷宗 开发进度月报 项目开发总结报告

开发人员

可行性研究报告 项目开发计划 软件需求说明书 数据要求说明书 概要设计说明书 详细设计说明书 数据库设计说明书 测试计划 测试分析报告

维护人员

设计说明书 测试分析报告 模块开发卷宗

用户

用户手册 操作手册

3. 软件生存周期各个阶段及其相应的各种文件的编制

3.1 软件生存周期

一个计算机软件，从出现构思，经过开发成功并投入使用，到停止使用，完成一个生存周期。这个周期可以分为6个阶段：

- 可行性与计划研究阶段 - 需求分析阶段 - 设计阶段 - 实现阶段 - 测试阶段 - 运行与维护阶段

3.2软件生存周期各阶段中各类文件的编制

3.3扩展的文件

当被开发的系统的规模非常大时，例如工作量超过30人月时，编写的文档应该按照以下的方法分类，以包含更加详细的内容。

4. 文件编制工作的管理

文件编制工作必须有管理工作的配合，才能使所编制的文件真正发挥作用。文件编制工作是一项贯穿整个软件开发过程的工作。因此对文件的管理必须贯彻整个开发过程。

在开发中必须进行的管理工作有：

4.1文件的形成

文件的形成是各个阶段开发工作正式完成的标志，因此，开发集体必须及时地对这些文件进行严格的评审。

开发人员在软件开发过程中，必须 - -

按照规定，及时完成各种产品文件的编写工作； 将开发过程中做出的决定和取得的修改及时写入文件；

文件中必须有编写者、评审者、批准者的签字，必须有编写、评审完成的日期和批准日期。

4.2文件分类与标识

为了便于文件的保存、查找、使用和修改，应该对文件按照层次加以分类组织。可以按照如下6个层次对文件加以分类和标识。

a 文件编号 b 文件所属项目标识 c 文件种类标识

d 每一种文件的不同版本号 e 页号 f 保密级别

4.3文件的控制

在软件开发过程中，随着程序的逐步形成和逐步修改，各种文件不断产生、修改和补充。因此，必须加以周密的控制，以保证文件与程序产品的一致性，保证文件之间的一致性和安全性。这种控制表现为：

(i). 对于一项软件开发工作，应设置一位专职的文件管理人员（可以由项目管理工程师担

当，也可以由专门的文档管理员担当）。在开发集体中，应该集体保管本项目现有全部文件的主文本2套，由该文件管理人员负责保管。

(ii). 每一份提交给文件管理人员的文件都必须有编写者、审核者和批准者的签字。 (iii). 这两套主文本的内容必须完全一致；其中一套是可以出借的，另一套是绝对不可以出

借的，以免发生万一。可出借的主文本在出借时必须办理出借手续，归还时办理注销

出借手续。

(iv). 开发集体中的工作人员可以根据工作的需要，在本项目的开发过程中持有一些文件，

即所谓个人文件，包括为使他完成他承担的任务所需要的文件，以及他在完成任务过程中所编制的文件；但这种个人文件必须是主文本的复制品，必须同住文本完全一致，若需修改，必须首先修改主文本。

(v). 不同开发人员所拥有的个人文件通常是主文本的各种子集。所谓子集是霸主文本的各

个部分根据所承担不同任务的人员的工作需要加以复制、组装而成的若干个文件的集合。文件管理人员应列出一份不同子集的分发对象的清单，按照清单及时把文件分发给有关的人员或部门。

(vi). 一份文件如果已被另一份新的文件所代替，则原文件应该被注销。文件管理人员应该

随时整理主文本，及时反映出文件的变化和增加情况，及时分发文件。

(vii). 当一个项目的开发工作临近结束时，文件管理人员应该逐个收回开发集体内每个成员

的个人文件，并检查这些个人文件的内容。如果发现这些个人文件比主文本更加详细，或不同于主文本，文件管理人员应监督有关人员进行修改，使主文本能真正反映出实际的开发结果。

4.4文档的修改管理

在开发过程中，开发集体内的任何成员对文件的修改都应该遵守以下规程：

(i). 提议 开发集体中的任何一个成员都可以向项目负责人提出修改建议，为此应该填写

一份修改建议表，说明修改的内容、所修改的文件和部位、以及修改理由。 (ii). 评议 有项目负责人或项目负责人指定的人对该修改建议进行评议，包括审核该修改

的必要性，确定这一修改的影响范围，研究进行修改的方法、步骤和实施计划。 (iii). 审核 由项目负责人进行审核，包括核实修改的目的和要求，核实修改或定将带来的

影响，审核修改或定是否可行。

(iv). 批准 又开发单位的部门负责人对修改计划进行批准。批准时，主要是决断修改工作

的各项活动的先后顺序及各自的完成日期，以保证整个开发工作按照原定计划日期完成。

(v). 实施 由项目负责人按照已经批准了的修改活动计划，安排各项修改活动的负责人员

进行修改，建立修改记录，产生新的文件以取代原有文件，做后把文件交文件管理人员归档，并分发给有关的持有者。