版次A/0作业指导文件软件文档的管理办法二○○四年五月一日发布1二○○四年五月十五日实施1目的为了保证所开发软件的质量，作为软件开发过程中重要的组成部分----软件文档，其管理是非常重要的，特制定本办法。适用范围本管理办法适用于本公司所有软件文档的管理。引用文件3.1GB/T19001-2000《质量管理体系要求》3.2GB/T19000-3.1994《在软件开发、供应和维护中的使用指南》3.3GB/TA16680-1996《软件文档管理指南》职责4.1副总经理负责对软件文档管理活动的组织与领导。4.2研发中心负责具体软件文档的编写。4.3综合管理部负责软件文档的具体归档及管理工作。4.4其他各部门协助技术质量部做好软件文档的管理工作。工作程序5.1文档的管理范围本公司所有开发软件中的相关文档。5.2软件文档的作用管理依据；任务之间联系的凭证；质量保证；培训与参考；软件维护支持；历史档案。5.3文档编制策略a.文档需要覆盖整个软件生存期；b.文档应是可管理的；c.文档应适合他的读者；d.文档应贯穿到软件的整个开发过程中；e.文档标准应被标识和使用；f.应规定支持工具。2（在需要时可对文档编制策略进行检查。文档策略检查表，见附录2中《文档策略检查表》）5.4规定文档类型和内容5.4.1软件文档归入如下三种类别开发文档——描述开发过程本身产品文档——描述开发过程的产物管理文档——记录项目管理的信息5.4.2开发过程中可能形成的文档包括：可行性研究和项目任务书；需求规格说明；功能规格说明；设计规格说明、包括程序和数据规格说明；开发计划；软件集成和测试计划；质量保证计划、标准、进度；安全和测试信息。（软件开发中心各项因素的总和同文件编制要求的关系。见附录1中表02）5.4.3基本的产品文档包括：培训手册；参考手册和用户指南；软件支持手册；产品手册和信息广告。5.4.4管理文档包括：开发过程的每个阶段的进度和进度变更的记录；软件变更情况的记录；相对于开发的判定记录；职责定义5.5制订文档规程：5.5.1文档计划一般内容列出应编制文档应参考的标准；提示编制文档应参考的标准；指定文档管理员；提供编制文档所需的条件，落实文档编写人员、所需经费以及编制工具等；明确保证文档质量的方法，为了确保文档内容的正确性、合理性，应采取一定的措施，如评审、鉴定等；3绘制进度表，以图表形式列出在软件生产开发期各阶段应产生的文档、编制日期、完成日期、评审日期等。5.5.2文档计划制定项目一旦确定，就应制定项目开发计划。5.5.3文档编写文档的编写是件非常细致的工作，从最初提出文档编写提纲开始，经过逐步充实、完善，并经过复检和修改，直至正式交付使用为止。编写文档应注意以下几点：文档编写时间应与软件开发同步，在软件生存期的每一个阶段都应完成相应的文档编写工作；按文档计划要求编写文档；按本单位指定的标准内容和格式编写相应的文档；每个文档必须装订成册，并加封面和目次；文档用纸的格式由各单位的有关标准格式编写相应文档；归档用的文档还应有扉面，用于各责任者的签署；软件文档的编制时间参见附录2中的《软件文档编制时间》表。5.5.4文档编号为便于管理，软件文档应按编号法进行编号，编号具有唯一性。5.6文档评审5.6.1概述文档评审十分重要，文档评审必须与技术评审结合起来。为了提高软件产品的质量，一个有效的方法就是在软件开发的每个阶段，对该阶段所形成的文档进行严格的评审，这样可尽早发现问题，并及时采取措施予以解决，从而确保文档内容的正确性，避免或减少大的返工，同时为进入下一阶段的工作做好组织上的技术上的准备。对一些大项目，正规评审通常在开发方法学指导下进行。正规评审应包括文档评审，这是为了保证文档不但正确，而且内容是最新的。如果对文档与开发工作的其他方面同样重要这一点强调不够，各种问题可能随之而来。对所有描述开发工作和产品的文档进行评审是正规评审过程的组成部分。一开始特别重要的是需求规格说明和设计规格说明的评审。5.6.2需求评审需求评审进一步确认开发者和设计者已了解用户要求什么，及用户从开发者一方了解某些限制和约束。4需求评审（可能需要一次以上）产生一个被认可的需求规格说明。基于对系统要作些什么的共同理解，才能着手详细设计。用户代表必须参与开发和需求评审，参与对需求文档的认可。5.6.3设计评审通常安排两个主要的设计评审：概要设计评审和详细设计评审。在概要设计评审过程中，主要详细评审每个系统组成部分的基本设计方法和测试计划。系统规格说明应根据概要设计评审的结果加以修改。