湖南金桥信息技术有限公司项目文档编写规范（试行）.docVIP

湖南金桥信息技术有限公司项目文档编写规范（试行） 项目文档编写规范（试行） 湖南金桥信息技术有限公司 文档编号 文档版本 密级 技术委员会 GSGF 1.01 B 项目文档编写规范（试行） 共 页 项目文档编写规范 （试行） 拟制： 日期： 审核： 日期： 审核： 日期： 批准： 日期： 湖南金桥信息技术有限公司 HuNan GoldenBridge InfoTech Co.,Ltd 修订记录 日期 修订版本 描述 作者 2001/12/03 1.01 初稿完成 罗辉 目录 41 概述 42 范围 52.1 软件生产文档 62.2 项目管理文档 63 说明 63.1 文档编号 73.2 保密级别 73.3 文档格式 83.4 版本控制 83.5 文档模板 概述 软件的文档在软件的设计、开发、使用各阶段都具有重要的作用，它和计算机程序共同构成了能完成特定功能的计算机软件。软件产品和硬件产品不同：硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于软件产品的设计、开发、实施、变更、修正、扩充和使用，对于充分发挥软件产品的效益有着重要意义。 图1.1文档的桥梁作用 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图1.1中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，通过这些资料，用户可以正确地使用软件，发挥软件的功效。 因此，为规范软件项目开发实施过程中各项文档的书写，保证软件的开发质量，方便进行系统维护，同时也减轻开发人员编写文档的工作量，特制定了本套项目文档规范。本规范指明了软件项目文档的范围，定义了各技术文档的模板，给出了各技术文档的编写规格以及主要的内容。 范围 根据各文档在项目实施过程中所起的不同作用，在本规范中，将需要编制的文档分为两类：软件生产文档和项目管理文档，分别对应于《软件生产规范》和《项目管理规范》。 软件生产文档 序号 文档名称 类型 编写阶段 可行性分析与计划 需求分析 概要设计 详细设计 编码/测试 验收 维护 1 可行性分析报告 KXFX 2 项目立项报告 LXBG 3 项目开发计划书 XMJH 4 需求规格说明书 XQGG 5 概要设计说明书 GYSJ 6 详细设计说明书 XXSJ 7 模块开发维护卷宗 MKJZ 8 测试计划说明书 CSJH 9 测试用例说明书 CSYL 10 测试报告说明书 CSBG 11 用户手册 YHSC 12 操作手册 CZSC 13 验收申请报告 YSSQ 14 验收报告 YSBG 15 开发过程点评审报告 JDPS 16 需求变更登记表 XQBG 17 软件问题跟踪报告 WTGZ 备注： 1、客户提出需求变更，除了填写需求变更登记表之外，在接受该需求变更之后，需修改《需求规格说明书》、《概要设计说明书》、《详细设计说明书》、《测试用例》、《用户手册》、《操作手册》、《模块开发维护卷宗》等文档中与该需求变更有关的相应内容。 2、软件问题的解决方法如果涉及到概要设计和详细设计的，则需修改《概要设计说明书》、《详细设计说明书》的相关内容。 3、表中的编写阶段仅供参考，各文档的具体编写时间请见《