软件文档管理指南课件.ppt

软件文档管理指南(GB/T16680-96) 简介 本标准为那些对软件或基于软件产品的开发负有职责的管理者提供软件文档的管理指南。目的在于协助管理者在他们的机构中产生有效的文档。 本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。 本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。 简介 不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。 本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。 引用标准 GB 8566-88 计算机软件开发规范 GB 8567-88 计算机软件产品开发文件编制指南 GB/T 11457-1995 软件工程术语 定义 文档 document 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。 文档（集）/ 文档编制 documentation 一个或多个相关文档的集合。 定义 文档计划 documentation plan 一个描述文档编制工作方法的管理用文档。 该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。 定义 文档等级 level of documentation 对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。 软件产品 software product 软件开发过程的结果，并推出供用户使用的软件实体。 主要内容 软件文档的作用 管理依据 质量保证 软件维护支持 主要内容 管理者的作用 管理者严格要求软件开发人员和编制组完成文档编制，并且在策略、标准、规程、资源分配和编制计划方面给予支持。 管理者对文档工作的责任 管理者要认识到正式或非正式文档都是重要的，还要认识到文档工作必须包括文档计划、编写、修改、形成、分发和维护等各个方面。 管理者对文档工作的支持 管理者应为编写文档的人员提供指导和实际鼓励，并使各种资源有效地用于文档开发。 管理者的主要职责 建立编制、登记、出版系统文档和软件文档的各种策略 把文档计划作为整个开发工作的一个组成部分 建立确定文档质量、测试质量和评审质量各种方法的规程 为文档的各个方面确定和准备各种标准和指南 积极支持文档工作以形成开发中自觉编制文档的团队风气 不断检查已建立起来的过程，以保证符合策略和各种规程并遵守有关标准和指南 项目管理者在开发前应决定的事项 要求哪些类型的文档 提供多少种文档 文档包含的内容 达到何种级别的质量水平 何时产生何种文档 如何保存、维护文档以及如何进行通信 主要内容 制订文档编制策略 文档策略由上级(资深)管理者准备并支持，对下级开发单位或开发人员提供指导。 策略规定主要的方向，不是做什么或如何做的详细说明。 一般说来，文档编制策略陈述要明确，并通告到每个人且理解它，进而使策略被他们贯彻实施。 支持有效文档策略的基本条件 文档需要覆盖整个软件生存期 在项目早期几个阶段就要求有文档，而且在贯穿软件开发过程中必须是可用的和可维护的。在开发完成后，文档应满足软件的使用、维护、增强、转换或传输。 文档应是可管理的 指导和控制文档的获得和维护，管理者和发行专家应准备文档产品、进度、可靠性、资源，质量保证和评审规程的详细计划大纲。 支持有效文档策略的基本条件 文档应适合于它的读者 读者可能是管理者、分析员、无计算机经验的专业人员、维护人员、文书人员等。根据任务的执行，他们要求不同的材料表示和不同的详细程度。针对不同的读者，发行专家应负责设计不同类型的文档。 文档效应应贯穿到软件的整个开发过程中 在软件开发的整个过程中，应充分体现文档的作用和限制，即文档应指导全部开发过程。 支持有效文档策略的基本条件 文档标准应被标识和使用 应尽可能地采纳现行的标准，若没有合适的现行标准，必要时应研制适用的标准或指南。 应规定支持工具 工具有助于开发和维护软件产品，包括文档。因此尽可能地使用工具是经济的、可行的。 主要内容 制订文档编制标准和指南 在一个机构内部，应采用一些标准和指南： 软件生存期模型 文档类型和相互关系 文档质量 这些标准和指南将决定如何实现文档任务，将提供一些准则以评价该机构内所产生的软件文档的完整性、可用性和适合性。 尽可能地采用现行的国家和国际标准，若现行的标准不适用，机构应制订自己的标准。 1. 选择软件生存期模型 现有的一些软件生存期模