文档介绍：1软件文档管理指南软件文档管理指南(GB/T16680-96) (GB/T16680-96) 2简介?本标准为那些对软件或基于软件产品的开发负有职责的管理者提供软件文档的管理指南。目的在于协助管理者在他们的机构中产生有效的文档。?本标准涉及策略、标准、规程、资源和计划,管理者必须关注这些内容,以便有效地管理软件文档。?本标准期望应用于各种类型的软件,从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档,作用于软件生存期的各个阶段。 3简介?不论项目的大小,软件文档管理的原则是一致的。对于小项目,可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。?本标准是针对文档编制管理而提出的,不涉及软件文档的内容和编排。 4引用标准? GB 8566-88 计算机软件开发规范? GB 8567-88 计算机软件产品开发文件编制指南? GB/T 11457-1995 软件工程术语 5定义?文档 document ?一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如,技术文件、设计文件、版本说明文件。?文档(集) / 文档编制 documentation ?一个或多个相关文档的集合。 6定义?文档计划 documentation plan ?一个描述文档编制工作方法的管理用文档。?该计划主要描述要编制什么类型的文档,这些文档的内容是什么,何时编写,由谁编写,如何编写,以及什么是影响期望结果的可用资源和外界因素。 7定义?文档等级 level of documentation ?对所需文档的一个说明,它指出文档的范围、内容、格式及质量,可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。?软件产品 software product ?软件开发过程的结果,并推出供用户使用的软件实体。 8主要内容?软件文档的作用?管理者的作用?制订文档编制策略?制订文档编制标准和指南?文档编制计划?制订文档规程?所需资源 9软件文档的作用?管理依据?质量保证?软件维护支持?任务之间联系的凭证?培训与参考?历史档案 10主要内容?软件文档的作用?管理者的作用?制订文档编制策略?制订文档编制标准和指南?文档编制计划?制订文档规程?所需资源