《GB_16680-1996_软件管理指南》.pdf

GB/16680－1996 软件文档管理指南 1 范围 本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理 指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。 本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管 理软件文档。 本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种 类型的软件文档，作用于软件生存期的各个阶段。 不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规 定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。 本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。 2 引用标准 下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时， 所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本 的可能性。 GB 8566-88 计算机软件开发规范 GB 8567-88 计算机软件产品开发文件编制指南 GB/T 11457-1995 软件工程术语 3 定义 本标准采用下列定义，其他定义见 GB/T 11457 。 3.1 文档 document 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于 描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。 3.2 文档（集）；文档编制 documentation 一个或多个相关文档的集合。 3.3 文档计划 documentation plan 一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档，这 些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资 源和外界因素。 3.4 文档等级 level of documentation 对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、 预期用途、作用范围或其他因素选择文档等级。 3.5 软件产品 software product 软件开发过程的结果，并推出供用户使用的软件实体。 4 软件文档的作用 a) 管理依据； b) 任务之间联系的凭证； c) 质量保证； d) 培训与参考； e) 软件维护支持； f) 历史档案。 4.1 管理依据 在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划 安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的 责任以及该部门效率的重要性。开发文档规定若干个检查点和进度表，使管理者可以评定项 目的进度，如果开发文档有遗漏，不完善，或内容陈旧，则管理者将失去跟踪和控制项目的 重要依据。 4.2 任务之间联系的凭证 大多数软件开发项目通常被划分成若干个任务，并由不同的小组去完成。学科方面的专 家建立项目，分析员阐述系统需求，设计员为程序员制定总体设计，程序员编制详细的程序 代码，质量保证专家和审查员评价整个系统性能和功能的完整性，负责维护的程序员改进各 种操作或增强某些功能。 这些人员需要的互相联系是通过文档资料的复制、分发和引用而实现的，因而，任务之 间的联系是文档的一个重要功能。大多数系统开发方法为任务的联系规定了一些正式文档。 分析员向设计员提供正式需求规格说明，设计员向程序员提供正式设计规格说明，等等。 4.3 质量保证 那些负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测 试该系统用的各种质量标准以及关于期望系统完成什么功能和系统怎样实现这些功能的清 晰说明；必须制订测试计划和测试规程，并报告测试结果；他们还必须说明和评估完全、控 制、计算、检验例行程序及其他控制技术。这些文档的提供可满足质量保证人员和审查人员 上述工作的需要。 4.4 培训与参考 软件文档的另一个功能是使系统管理员、操作员、用户、管理者和其他有关人员了解系 统如何工作，以及为了达到他们的各自的目的，如何使用系统。 4.5 软件维护支持 维护人员需要软件系统的详细说明以帮助他们熟悉系统，找出并修正错误，改进系统以