软件文档管理指南(2)

申请免费试用、咨询电话：400-8352-114

　　历史档案。软件文档可用作未来项目的一种资源。通常文档记载系统的开发历史，可使有关系统结构的基本思想为以后的项目利用。系统开发人员通过审阅以前的系统以查明什么部分已试验过了，什么部分运行得很好，什么部分因某种原因难以运行而被排除。良好的系统文档管理有助于把程序移植和转移到各种新的系统环境中。

　　管理者的作用。管理者严格要求软件开发人员和编制组完成文档编制，并且在策略、标准、规程、资源分配和编制计划方面给予支持。

　　制订文档编制策略：文档策略是由上级(资深)管理者新任务并支持的，对下级开发单位或开发人员提供指导。策略规定主要的方向不是做什么或如何做的详细说明。

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

　　规定文档类型和内容。软件文档归入如下三种类别：开发文档——描述开发过程本身;产品文档——描述开发过程的产物;管理文档——记录项目管理的信息。

　　开发文档。是描述软件开发过程，包括软件需求、软件设计、软件测试、保证软件质量的一类文档，开发文档也包括软件的详细技术描述(程序逻辑、程序间相互关系、数据格式和存储等)。开发文档起到如下五种作用：它们是软件开发过程中包含的所有阶段之间的通信工具，它们记录生成软件需求、设计、编码和测试的详细规定和说明;它们描述开发小组的职责。通过规定软件、主题事项、文档编制、质量保证人员以及包含在开发过程中任何其他事项的角色来定义做直截了当、如何做和何时做;它们用作检验点而允许管理者评定开发进度。如果开发文档丢失、不完整或过时，管理者将失去跟踪和控制软件项目的一个重要工具;它们形成了维护人员所要求的基本的软件支持文档。而这些支持文档可作为产品文档的一部分;它们记录软件开发的历史。

　　基本的开发文档是：可行性研究和项目任务书;需求规格说明;功能规格说明;设计规格说明，包括程序和数据规格说明;开发计划;软件集成和测试计划;质量保证计划、标准、进度;安全和测试信息。

　　产品。规定关于软件产品的使用、维护、增强、转换和传输的信息。产品的文档起到如下三种作用：为使用和运行软件产品的任何人规定培训和参考信息;使得那些未参加开发本软件的程序员维护它;促进软件产品的市场流通或提高可接受性。

　　产品文档用于下列类型的读者：用户;运行者;维护人员。

　　产品文档包括如下内容：用于管理者的指南和资料，他们监督软件的使用;宣传资料通告软件产品的可用性并详细说明它的功能、运行环境等;般信息 对任何有兴趣的人描述软件产品。

　　基本的产品文档包括：培训手册;参考手册和用户指南;软件支持手册;产品手册和信息广告。

　　管理文档。这种文档建立在项目管理信息的基础上，诸如：开发过程的每个阶段的进度和进度变更的记录;软件变更情况的记录;相对于开发的判定记录职责定义。

　　确定文档的质量等级。仅仅依据规章、传统的做法或合同的要求去制作文档是不够的。管理者还必须确定文档的质量要求以及如何达到和保证质量要求。质量要求的确定取决于可得到的资源、项目的大小和风险，可以对该产品的每个文档的格式及详细程度作出明确的规定。每个文档的质量必须在文档计划期间就有明确的规定。文档的质量可以按文档的形式和列出的要坟划分为四级。最低限度文档(1级文档);内部文档(2级文档);工作文档(3级文档);正式文档(4级文档)。

　　文档编制计划。文档计划可以是整个项目计划的一部分或是一个独立的文档。应该编写文档计划并把它分发给全体开发组成员，作为文档重要性的具体依据和管理部门文档工作责任的备忘录。文档计划一般包括以下几方面内容：列出应编制文档的目录;提示编制文档应参考的标准;指定文档管理员;提供编制文档所需要的条件，落实文档编写人员、所需经费以及编制工具等;明确保证文档质量的方法，为了确保文档内容的正确性、合理性，应采取一定的措施，如评审、鉴定等。