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

'软件开发项目中文档编制及其管理规范1.文件种类计算机软件所包含的文件有2类，一类是开发过程中填写的各种图表，称Z为工作表格;另一类是应编制的技术资料或技术管理资料，称为文档。在一项计算机软件的开发过程屮，一般地说，应该产牛14种文件：-可行性研究报告・项目开发计划-软件需求说明书・数据要求说明书・概要设计说明书-详细设计说明书・数据库设计说明书-用户手册・操作手册-模块开发卷宗・测试计划-测试分析报告・开发进度月报 ・项目开发总结报告 1.使用文件的人员以及所关心的文件:「人员「文件种类1管理人员可行性研究报告模块开发卷宗开发进度月报项冃开发总结报告开发人员可行性研究报告项目开发计划软件需求说明书数据耍求说明书概要设计说明书详细设计说明书数据库设计说明书测试计划测试分析报告维护人员设计说明书测试分析报告模块开发卷宗用户用户手册操作手册 1.软件生存周期各个阶段及其相应的各种文件的编制3.1软件生存周期一个计算机软件，从出现构思，经过开发成功并投入使用，到停止使用，完成一个生存周期。这个周期可以分为6个阶段：・可行性与计划研究阶段・需求分析阶段-设计阶段・实现阶段-测试阶段・运行与维护阶段3.2软件生存周期各阶段中各类文件的编制介段文件可行性研究与计划阶段需求分析阶段设计阶段实现阶段测试阶段运行与维护阶段可行性研究报告项目开发计划软件需求说明书数据要求说明书测试计划r「・•••••概要设计说明书详细设计说明书数据库设计说明书—-----------------模块开发卷宗用户手册操作手册……----……j—1L___—————————T丁测试分析报告开发进度月报项目开发总结 3.3扩展的文件当被开发的系统的规模非常大时，例如工作量超过30人刀时，编写的文档应该按照以下的方法分类，以包含更加详细的内容。文件人类详细分类文件大类详细分类可行性研究报告数据库设计说明书项目开发计划质量保证计划配置管理计划用户培训计划安装实施计划模块开发卷宗软件需求说明书用户手册数据要求说明书操作手册操作手册安装实施过程测试计划测试计划测试设计说明测试规程测试用例测试分析报告综合测试报告验收测试报告概要设计说明书系统设计说明书子系统设计说明书异发进度刀报详细设计说明书程序设计说明书接口设计说明书版本说明项目开发总结 1.文件编制工作的管理文件编制工作必须有管理工作的配合，才能使所编制的文件真正发挥作用。文件编制工作是一项贯穿整个软件开发过程的工作。因此对文件的管理必须贯彻整个开发过程。在开发中必须进行的管理工作冇：4.1文件的形成文件的形成是各个阶段开发工作正式完成的标志，因此，开发集体必须及时地对这些文件进行严格的评审。开发人员在软件开发过程中，必须-按照规定，及时完成各种产品文件的编写工作；・将开发过程中做出的决定和取得的修改及时写入文件；文件中必须冇编写者、评审者、批准者的签字，必须冇编写、评审完成的口期和批准口期。4.2文件分类与标识为了便于文件的保存、杳找、使用和修改，应该对文件按照层次加以分类纽织。可以按照如下6个层次对文件加以分类和标识。a文件编号b文件所属项目标识c文件种类标识d每一种文件的不同版木号e页号f保密级别4.3文件的控制在软件开发过程中，随着程序的逐步形成和逐步修改，各种文件不断产生、修改和补充。因此，必须加以周密的控制，以保证文件打程序产品的一致性，保证文件Z间的一致性和安全性。这种控制表现为：(i).对于一项软件开发工作，应设置-•位专职的文件管理人员(可以由项目管理工程师担当，也可以由专门的文档管理员担当)。在开发集体中，应该集体保管木项冃现冇全部文件的主文本2套，由该文件管理人员负责保管。(ii).每一份提交给文件管理人员的文件都必须有编写者、审核者和批准者的签字。(iii).这两套主文木的内容必须完全一致；其屮一套是可以出借的，另一套是绝对不可以出借的，以免发生万一。可出借的主文木在出借时必须办理出借手续，归还时办理注销 出借手续。(i).开发集体屮的工作人员可以根据工作的需要，在本项目的开发过程屮持有一些文件，即所谓个人文件，包括为使他完成他承担的任务所需要的文件，以及他在完成任务过程中所编制的文件；但这种个人文件必须是主文木的复制品，必须同住文本完全一致,若需修改，必须首先修改主文木。(V).不同开发人员所拥侑的个人文件通常是主文木的各种子集。所谓子集是霸主文木的各个部分根据所承担不同任务的人员的工作需要加以复制、组装而成的若干个文件的集合。文件管理人员应列出一份不同子集的分发对彖的清单，按照清单及时把文件分发给有关的人员或部门。(vi).i份文件如果己被另一-份新的文件所代替，贝IJ原文件应该被注销。文件管理人员应该随时整理主文本，及时反映出文件的变化和增加情况，及时分发文件。(vii).当一个项目的开发工作临近结束时，文件管理人员应该逐个收回开发集体内每个成员的个人文件，并检查这些个人文件的内容。如果发现这些个人文件比主文本更加详细,或不同于主文木，文件管理人员应监督有关人员进行修改，使主文木能真正反映出实际的开发结果。4.4文档的修改管理在开发过程中，开发集体内的任何成员对文件的修改都应该遵守以下规程：(i).提议开发集体屮的任何一个成员都可以向项目负责人提出修改建议，为此应该填写i份修改建议表，说明修改的内容、所修改的文件和部位、以及修改理由。(ii).评议冇项冃负责人或项冃负责人指定的人对该修改建议进行评议，包括审核该修改的必要性，确定这一修改的影响范围，研究进行修改的方法、步骤和实施讣划。(iii).审核由项目负责人进行审核，包括核实修改的日的和要求，核实修改或定将带来的影响，审核修改或定是否可行。(iv).批准又开发单位的部门负责人对修改计划进行批准。批准吋，主要是决断修改工作的各项活动的先后顺序及各口的完成日期，以保证整个开发工作按照原定计划日期完成。(V).实施由项目负责人按照己经批准了的修改活动计划，安排各项修改活动的负责人员进行修改，建立修改记录，产牛新的文件以取代原有文件，做后把文件交文件管理人员归档，并分发给有关的持有者。'