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