00-软件开发文档编制规范.docVIP

TITLE 文档编制及其管理规范 第 PAGE \* MERGEFORMAT 1页 / 共 NUMPAGES \* MERGEFORMAT 6页软件开发项目中文档编制及其管理规范1. 文件种类 计算机软件所包含的文件有2类，一类是开发过程中填写的各种图表，称之为工作表格；另一类是应编制的技术资料或技术管理资料，称为文档。 在一项计算机软件的开发过程中，一般地说，应该产生14种文件：可行性研究报告项目开发计划软件需求说明书数据要求说明书概要设计说明书详细设计说明书数据库设计说明书用户手册操作手册模块开发卷宗测试计划测试分析报告开发进度月报项目开发总结报告2. 使用文件的人员以及所关心的文件：人员文件种类管理人员可行性研究报告模块开发卷宗开发进度月报项目开发总结报告开发人员可行性研究报告项目开发计划软件需求说明书数据要求说明书概要设计说明书详细设计说明书数据库设计说明书测试计划测试分析报告维护人员设计说明书测试分析报告模块开发卷宗用户用户手册操作手册3. 软件生存周期各个阶段及其相应的各种文件的编制3.1 软件生存周期一个计算机软件，从出现构思，经过开发成功并投入使用，到停止使用，完成一个生存周期。这个周期可以分为6个阶段：可行性与计划研究阶段需求分析阶段设计阶段实现阶段测试阶段运行与维护阶段3.2软件生存周期各阶段中各类文件的编制 阶段文件可行性研究与计划阶段需求分析阶段设计阶段实现阶段测试阶段运行与维护阶段可行性研究报告项目开发计划软件需求说明书数据要求说明书测试计划概要设计说明书详细设计说明书数据库设计说明书模块开发卷宗用户手册操作手册测试分析报告开发进度月报项目开发总结3.3扩展的文件当被开发的系统的规模非常大时，例如工作量超过30人月时，编写的文档应该按照以下的方法分类，以包含更加详细的内容。文件大类详细分类文件大类详细分类可行性研究报告数据库设计说明书项目开发计划质量保证计划配置管理计划用户培训计划安装实施计划模块开发卷宗软件需求说明书用户手册数据要求说明书操作手册操作手册安装实施过程测试计划测试计划测试设计说明测试规程测试用例测试分析报告综合测试报告验收测试报告概要设计说明书系统设计说明书子系统设计说明书开发进度月报详细设计说明书程序设计说明书接口设计说明书版本说明项目开发总结4. 文件编制工作的管理文件编制工作必须有管理工作的配合，才能使所编制的文件真正发挥作用。文件编制工作是一项贯穿整个软件开发过程的工作。因此对文件的管理必须贯彻整个开发过程。在开发中必须进行的管理工作有：4.1文件的形成文件的形成是各个阶段开发工作正式完成的标志，因此，开发集体必须及时地对这些文件进行严格的评审。开发人员在软件开发过程中，必须按照规定，及时完成各种产品文件的编写工作；将开发过程中做出的决定和取得的修改及时写入文件；文件中必须有编写者、评审者、批准者的签字，必须有编写、评审完成的日期和批准日期。4.2文件分类与标识为了便于文件的保存、查找、使用和修改，应该对文件按照层次加以分类组织。可以按照如下6个层次对文件加以分类和标识。文件编号文件所属项目标识文件种类标识每一种文件的不同版本号页号保密级别4.3文件的控制在软件开发过程中，随着程序的逐步形成和逐步修改，各种文件不断产生、修改和补充。因此，必须加以周密的控制，以保证文件与程序产品的一致性，保证文件之间的一致性和安全性。这种控制表现为：对于一项软件开发工作，应设置一位专职的文件管理人员（可以由项目管理工程师担当，也可以由专门的文档管理员担当）。在开发集体中，应该集体保管本项目现有全部文件的主文本2套，由该文件管理人员负责保管。每一份提交给文件管理人员的文件都必须有编写者、审核者和批准者的签字。这两套主文本的内容必须完全一致；其中一套是可以出借的，另一套是绝对不可以出借的，以免发生万一。可出借的主文本在出借时必须办理出借手续，归还时办理注销出借手续。开发集体中的工作人员可以根据工作的需要，在本项目的开发过程中持有一些文件，即所谓个人文件，包括为使他完成他承担的任务所需要的文件，以及他在完成任务过程中所编制的文件；但这种个人文件必须是主文本的复制品，必须同住文本完全一致，若需修改，必须首先修改主文本。不同开发人员所拥有的个人文件通常是主文本的各种子集。所谓子集是霸主文本的各个部分根据所承担不同任务的人员的工作需要加以复制、组装而成的若干个文件的集合。文件管理人员应列出一份不同子集的分发对象的清单，按照清单及时把文件分发给有关的人员或部门。一份文件如果已被另一份新的文件所代替，则原文件应该被注销。文件管