软件开发技术文档管理规范

《软件开发技术文档管理规范》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、软件开发因果图制作指导书ISO9001质量体系作业文件名称：软件开发技术文档管理规范编号：版号拟制：日期审核：日期批准：日期生效日期：受控状态：发文号：会签部门会签人/日期会签部门会签人/日期Powerise®PRS_SCTC创智软件园配置测试中心第2页共1页软件开发技术文档管理规范目录1.前言11.1目的11.2术语11.3参考文献11.4版本说明和修改历史12.软件文档12.1文档的定义及作用12.2软件文档的分类22.3软件文档的制作与软件生存周期之间的关系32.4文档的使用者33.文档编制格式规范43.1文档编码规则43.

2、2文档组成格式43.2.1封面53.2.2目录63.2.3版本更新说明63.2.4文件内容63.2.5正文格式73.3文档制作工具74.文档管理规范74.1文档管理岗位职责74.2文档的制作84.2.1文档的分类、编码与标识84.2.2文档的作者、修改者和打字者84.3文档的收集84.4文档的配置94.5文档的控制94.6文档的修改管理94.7文档的借阅和复制管理制度104.8文档的保密性105.技术文档的质量评价11第16页共18页软件开发技术文档管理规范1.前言1.1目的软件开发的不同阶段都会产生大量的文档。为了加强管理、提高

3、工作效率，充分借鉴前人的经验，对文档进行规范化管理是很有必要的。它对于保管在开发中形成的文档，为公司积累宝贵的技术知识的财富，为今后的软件开发工作提供第一手的宝贵资料起着重要的作用。为了规范创智集团工程项目的开发工作，根据国家标准局制定的有关软件开发和开发文件的规范标准，结合公司的实际，制定本规范。1.2术语略。1.3参考文献1)《1998计算机软件工程规范----国家标准》中国标准出版社1998年6月第一版。2)《软件工程概论》郑人杰等清华大学出版社1998年4月第一版。3)《实用软件工程》郑人杰等清华大学出版社1997年4月第

4、二版。4)《创智软件园文档管理规范》创智（湖南）软件园有限公司1996年5月。5)《创智软件园软件开发管理规范》创智（湖南）软件园有限公司1995年12月。1.4版本说明和修改历史本规范是在公司原有文档规范的基础上，于1999年05月份修订而成，具体的修订人员为孙继纲、赵海等。2.软件文档2.1文档的定义及作用第16页共18页软件开发技术文档管理规范文档（document）是指某种数据媒体和其中所记录的数据。它具有永久性，并可以由人或机器阅读，通常仅用于描述人工可读的东西。正确地制作和使用软件文档，可以获得如下的便利：l提高软件开

5、发过程的能见度。l提高开发效率。l作为开发人员在一定阶段的工作成果和结束标志。l记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。l便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。1.1软件文档的分类对于软件文档的分类有多种方法。从形式上分为两类：l开发过程中可以填写的各种图表，可称之为工作表格。l应编制的技术资料或技术管理资料，可称之为文档或文件。按照软件文档的产生和使用范围可以分为三类：l开发文档：软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包

6、括可行性研究、项目开发计划、需求说明、数据说明、概要设计和详细设计。l管理文档：软件开发过程中，由软件开发人员制定的需提交管理人员的一些工作计划和工作报告，包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。l用户文档：软件开发人员为用户准备的有关该软件使用、操作、维护的资料，包括用户手册、操作手册、维护修改建议、需求说明。按照计算机软件产品开发文件编制指南的国家标准（GB8567-88）的要求，在一项计算机软件的开发过程中，一般地说，应该产生14种文件：l可行性研究报告。l项目开发计划。l软件需求说明书。l数据要求

7、说明书。l概要设计说明书。l详细设计说明书。l数据库设计说明书。l用户手册。l操作手册。l模块开发卷宗。l测试计划。l测试分析报告。l开发进度月报。l项目开发总结报告。第16页共18页软件开发技术文档管理规范1.1软件文档的制作与软件生存周期之间的关系一般而言，计算机软件生存周期可以分为六个阶段：l可行性与计划研究阶段。l需求分析阶段。l设计阶段。l实现阶段。l测试阶段。l运行与维护阶段。在软件开发的不同阶段，产生的软件文档不同，具体对应关系如下表所示。阶段文档可行性研究与计划阶段需求分析阶段设计阶段实现阶段测试阶段运行与维护阶段

8、可行性研究报告项目开发计划软件需求说明书数据要求说明书测试计划概要设计说明书详细设计说明书数据库设计说明书模块开发卷宗用户手册操作手册测试分析报告开发进度月报项目开发总结1.2文档的使用者对于软件文档的使用人员而言，与其所承担的工作有关，具体情况如