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

湖南金桥信息技术有限公司项目文档编写规范（试行）项目文档编写规范（试行）湖南金桥信息技术有限公司文档编号文档版本密级技术委员会GSGF20021206101B项目文档编写规范（试行）共页项目文档编写规范（试行）拟制日期审核日期审核日期批准日期湖南金桥信息技术有限公司HUNANGOLDENBRIDGEINFOTECHCO,LTD修订记录日期修订版本描述作者2001/12/03101初稿完成罗辉目录41概述42范围521软件生产文档622项目管理文档63说明631文档编号732保密级别733文档格式834版本控制835文档模板概述软件的文档在软件的设计、开发、使用各阶段都具有重要的作用，它和计算机程序共同构成了能完成特定功能的计算机软件。软件产品和硬件产品不同硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制DOCUMENTATION在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于软件产品的设计、开发、实施、变更、修正、扩充和使用，对于充分发挥软件产品的效益有着重要意义。图11文档的桥梁作用文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图11中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，通过这些资料，用户可以正确地使用软件，发挥软件的功效。因此，为规范软件项目开发实施过程中各项文档的书写，保证软件的开发质量，方便进行系统维护，同时也减轻开发人员编写文档的工作量，特制定了本套项目文档规范。本规范指明了软件项目文档的范围，定义了各技术文档的模板，给出了各技术文档的编写规格以及主要的内容。范围根据各文档在项目实施过程中所起的不同作用，在本规范中，将需要编制的文档分为两类软件生产文档和项目管理文档，分别对应于软件生产规范和项目管理规范。软件生产文档序号文档名称类型编写阶段可行性分析与计划需求分析概要设计详细设计编码/测试验收维护1可行性分析报告KXFX2项目立项报告LXBG3项目开发计划书XMJH4需求规格说明书XQGG5概要设计说明书GYSJ6详细设计说明书XXSJ7模块开发维护卷宗MKJZ8测试计划说明书CSJH9测试用例说明书CSYL10测试报告说明书CSBG11用户手册YHSC12操作手册CZSC13验收申请报告YSSQ14验收报告YSBG15开发过程点评审报告JDPS16需求变更登记表XQBG17软件问题跟踪报告WTGZ备注1、客户提出需求变更，除了填写需求变更登记表之外，在接受该需求变更之后，需修改需求规格说明书、概要设计说明书、详细设计说明书、测试用例、用户手册、操作手册、模块开发维护卷宗等文档中与该需求变更有关的相应内容。2、软件问题的解决方法如果涉及到概要设计和详细设计的，则需修改概要设计说明书、详细设计说明书的相关内容。3、表中的编写阶段仅供参考，各文档的具体编写时间请见软件生产规范。项目管理文档序号文档名称类型编写阶段编写人1项目开发计划XMJH立项通过之后项目经理2项目开发日志XMRZ每天项目每位成员3项目工作报告GZBG每周、每季度项目经理4项目工作计划GZJH每周、每季度项目经理5项目会议记录HYJL每次会议项目经理6待处理事项清单DCLX每周项目经理7项目总结报告XMZJ项目结束之后项目经理8项目人力资源调查表RLZY项目结束之后项目经理9项目督促反馈报告DCFK发生督促时督促人、项目经理10项目实地审查报告SDSC发生实地审查时实地审查人备注1、在立项通过之后，项目经理需根据需求的内容制定详细的项目开发计划。在项目开发过程中，如果由于各种原因引起计划延误或提前，项目经理需根据实际情况对项目开发计划进行合理的调整，并将调整后的计划报部门经理审核。2、项目组的每位成员必须填写项目开发日志，每周经项目经理汇总后和每周的项目工作报告一起报送部门经理。3、表中的编写阶段及编写人仅供参考，具体要求请见项目管理规范。说明文档编号文档编号规则如下文档类型简写（4位）项目编号（7位）序号（2位）其中项目编号规则为地区标识（2位）客户标识（2位）项目标识（2位）识别位（1位；如果两个项目的前6位项目编号相同，则以识别位区分），新项目的项目编号在项目立项时由技术委员会统一分配。例如台山市农村信用合作社综合业务网络系统的需求说明规格书（第一版）的文档编号为XQGGTSNXBSA01。一、常用地区识别码地区名称标识珠海ZH镇江ZJ兰州LZ新会XH台山TS鹤山HS沧州CZ平顶山PD西宁XN二、常用客户识别码客户名称识别码商业银行SH农村信用合作社NX内部项目NB三、常用项目识别码项目名称识别码综合业务系统BS办公自动化系统OA决策支持系统DS卡系统CSEASYNET中间件EN中介业务平台IB保密级别保密级别从低到高分为如下级别级别说明A公司内部公开，并且可向相关客户公开B只限于公司内部公开C只限于部门内部公开D只限于部门负责人一级E只限于总经办一级F只限于董事长一级文档格式本规范涉及的各文档统一采用如下排版格式标题一字体宋体、小一、黑体段落15倍行距例子1标题一标题二字体宋体、小二、黑体段落15倍行距例子11标题二标题三字体宋体、三号、黑体段落15倍行距例子111标题三标题四字体宋体、小三、黑体段落15倍行距例子1111标题四正文字体仿宋_GB2312、小四、正常体段落固定行距、23磅例子正文版本控制任何文档都需进行版本控制，版本号的结构为主版本号次版本号，例如第一版的版本号为101。文档内容每次修改之后版本号必须进行相应的调整局部的变动可修改次版本号，涉及范围比较大的变动则可调整主版本号。相应的文档编号中的序号也需作出调整。文档每次修改之前必须保留旧版本的文档，即新版本不能覆盖老版本，以备进行追溯。例如，某项目的需求规格说明书进行过三次修改，分别是101201202版，则相应的应有三个需求规格说明书的文档需求规格说明书01；需求规格说明书02；需求规格说明书03，对应于上诉的三个版本。在制定软件的配置管理计划时，应注意保证文档的版本必须和软件的版本保持关联性。例如在某项目中以需求规格说明书103为基础进行概要设计、详细设计、编码和实施，相应产生了概要设计说明书101和详细设计说明书102、用户手册101、维护手册101等文档以及软件101版，则上述文档都是软件101产品的组成部分，必须作为一个整体看待，统一进行备档。如果以后需求发生了变化，产生了需求规格说明书202，相应的设计、编码也作了修改，分别产生了概要设计说明书201、详细设计说明书201、用户手册201、维护手册201等文档以及软件201版，则上述文档就是软件201产品的组成部分，不能和软件101相混淆。文档模板本规范所涉及的各项目文档的模板如下所列（对于本规范未定义的文档，亦提供了一个通用文档模板供参考，以便统一文档格式和风格）一、软件生产文档序号文档名称模板文件1可行性分析报告可行性分析报告模板2项目立项报告项目立项报告模板3项目开发计划书项目开发计划书模板4需求规格说明书需求规格说明书模板5概要设计说明书概要设计说明书模板6详细设计说明书详细设计说明书模板7模块开发维护卷宗模块开发维护卷宗8测试计划说明书测试计划模板9测试用例说明书测试用例模板10测试报告说明书测试报告模板11用户手册暂缺12操作手册暂缺13验收申请报告验收申请报告模板14验收报告验收报告模板15开发过程点评审报告开发过程点评审报告模板开发过程点评审报告封面模板16需求变更登记表需求变更登记表模板需求变更登记表封面模板17软件问题跟踪报告软件问题跟踪报告模板软件问题跟踪报告封面模板二、项目管理文档序号文档名称模板文件1项目开发日志项目开发日志模板项目开发日志封面模板2项目工作报告项目工作报告（周）模板项目工作报告（周）封面模板项目工作报告（阶段）模板项目工作报告（阶段）封面模板3项目工作计划项目工作计划（阶段）模板项目工作计划（阶段）封面模板4项