软件文档管理指南.doc

《软件文档管理指南.doc》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、软件文档管理指南1范围本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。本标准期望应用于务种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。本标准是针对文档编制管理而提出的，不涉及软件文档的内容和

2、编排。2引用标准下列标准所包含的条文，通过在本标准中引用呦构成为本标准的条文。本标准出版时，所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。GB8566-88计算机软件开发规范GB8567-88计算机软件产品开发文件编制指南GB/T11457-1995软件工程术语3定义本标准采用下列定义，其他定义见GB/T11457。3.1文档document一种数据媒体和英上所记录的数据。它具有永久性并可以山人或机器阅读。通常仅用于描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。3.2文档（集）：文档编制do

3、cumentation一个或多个相关文档的集合。3.3文档计划documentationplan一个描述文档编制工作方法的管理用文档°该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，山谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。3.4文档等级levelofdocumentation对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。3.5软件产品softwareproduct软件开发过程的结果，并推岀供用户使用的软件实体。4软件文档的作用a）管

4、理依据；b）任务之间联系的凭证；c）质量保证；d）培训与参考；e）软件维护支持；f）丿力史档案。4.1管理依据在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。每一•阶段计划安排的定期报告提供了项目的可见性。定期报告述提醒齐级管理者注意该部门对项目承担的责任以及该部门效率的重要性。开发文档规定若于个检查点和进度表，使管理者可以评定项目的进度，如果开发文档有遗漏，不完善，或内容陈旧，则管理者将失去跟踪和控制项目的重要依据。4.2任务之间联系的凭证大多数软件开发项目通常被划分成若干个任务，并山不同的小组去完成。学科方面的专家建立项日，分析

5、员阐述系统需求,设计员为程序员制定总体设计,程序员编制详细的程序代码，质最保证专家和审查员评价整个系统性能和功能的完整性，负责维护的程序员改进各种操作或增强某些功能。这些人员需要的互相联系是通过文档资料的复制、分发和引用而实现的，因而，任务之间的联系是文档的一个重要功能。大多数系统开发方法为任务的联系规定了一些止式文档。分析员向设计员提供正式需求规格说明，设计员向程序员提供正式设计规格说明，等等。4.3质量保证那些负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测试该系统用的齐种质最标准以及关于期望系统完成什么功能和系统怎样实

6、现这吐功能的淸晰说明；必须制订测试计划和测试规程，并报告测试结果；他们还必须说明和评估完全、控制、计算、检验例行程序及其他控制技术。这些文档的提供可满足质量保证人员和审查人员上述工作的需要。4.4培训与参考软件文档的另一个功能是使系统管理员、操作员、用户、管理者和其他有关人员了解系统如何工作，以及为了达到他们的各自的目的，如何使用系统。4.5软件维护支持维护人员需要软件系统的详细说明以帮助他们熟悉系统，找出并修止错误，改进系统以适应用户需求的变化或适应系统环境的变化°4.6历史档案软件文档可用作未來项目的一种资源。通常文档记载系统的开发丿力史，可使

7、有关系统结构的基本思想为以后的项目利用。系统开发人员通过审阅以前的系统以杏明什么部分己试验过了，什么部分运行得很好，什么部分因某种原因难以运行而被排除。良好的系统文档有助于把程序移植和转移到各种新的系统环境中。5管理者的作用管理者严格要求软件开发人员和编制组完成文档编制，并且在策略、标准、规程、资源分配和编制计划方而给予支持。a）管理者对文档工作的责任。管理者要认识到止式或非止式文档都是重要的，还要认识到文档工作必须包括文档计划、编写、修改、形成、分发和维护等各个方而。b）管理者对文档工作的支持。管理者应为编写文档的人员提供指导和实际鼓励，并使各种

8、资源有效地用于文档开发。c）管理者的主要职责：1）建立编制、登记、出版系统文档和软件文档的各种策略；2）把文档计划作为整个