软件文档管理指南.docVIP

PAGE4

软件文档管理指南

1范围

本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。

本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。

本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。

不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。

本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。

2引用标准

下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时，所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准必威体育精装版版本的可能性。

GB8566-88计算机软件开发规范

GB8567-88计算机软件产品开发文件编制指南

GB/T11457-1995软件工程术语

3定义

本标准采用下列定义，其他定义见GB/T11457。

3.1文档document

一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。

3.2文档（集）；文档编制documentation

一个或多个相关文档的集合。

3.3文档计划documentationplan

一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。

3.4文档等级levelofdocumentation

对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。

3.5软件产品softwareproduct

软件开发过程的结果，并推出供用户使用的软件实体。

4软件文档的作用

a)管理依据；

b)任务之间联系的凭证；

c)质量保证；

d)培训与参考；

e)软件维护支持；

f)历史档案。

4.1管理依据

在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的责任以及该部门效率的重要性。开发文档规定若干个检查点和进度表，使管理者可以评定项目的进度，如果开发文档有遗漏，不完善，或内容陈旧，则管理者将失去跟踪和控制项目的重要依据。

4.2任务之间联系的凭证

大多数软件开发项目通常被划分成若干个任务，并由不同的小组去完成。学科方面的专家建立项目，分析员阐述系统需求，设计员为程序员制定总体设计，程序员编制详细的程序代码，质量保证专家和审查员评价整个系统性能和功能的完整性，负责维护的程序员改进各种操作或增强某些功能。

这些人员需要的互相联系是通过文档资料的复制、分发和引用而实现的，因而，任务之间的联系是文档的一个重要功能。大多数系统开发方法为任务的联系规定了一些正式文档。分析员向设计员提供正式需求规格说明，设计员向程序员提供正式设计规格说

在软件开发的整个过程中，应充分体现文档的作用和限制，即文档应指导全部开发过程。

文档标准应被标识和使用

应尽可能地采纳现行的标准，若没有合适的现行标准，必要时应研制适用的标准或指南。

应规定支持工具

工具有助于开发和维护软件产品，包括文档。因此尽可能地使用工具是经济的、可行的。

附录A中的检查表为制定策略条款或评估现有策略条款的有效性和完整性提供帮助。

7制订文档编制标准和指南

在一个机构内部，应采用一些标准和指南：

——软件生存期模型；

——文档类型和相互关系；

——文档质量。

这些标准和指南决定如何实现文档任务，将提供一些准则以评价机构内所产生的软件文档的完整性、可用性和适合性。

尽可能地采用现行的国家和国际标准，若现行的标准不适用，机构应制订自己的标准。

7.1选择软件生存期模型

现有的一些软件生存期模型，对于不同的阶段有不同的词汇，从软件文档的观点来看，采用哪种模型都无关紧要，只要阶段和相应的文档是清晰定义的、已计划的，并且对于任何具体软件项目是能遵循的。因此，管理者应选择一个软件生存期模型并保证该模型在他们机构内是适用的。

管理者将会发现所进行的阶段和相应任务的定义有助于监控软件项目的进展。相应于特定阶段生成的文档可用作该阶段的评审、通过和完成的检验点，而这种检验应在下一阶段开始前进行。

7.2规定文档类