第11章 文档管理

软件项目开发方法与管理第11章文档管理711.1文档管理概述11.1.1文档管理的概念软件文档是与软件研制、维护和使用有关的材料，是以人们可读的形式表示的技术数据和信息。软件文档规定软件设计细节、说明软件功能、描述软件使用方法。软件文档和计算机程序一起构成一个完成特定功能的软件跟踪项目。作为开发组成员之间交流沟通的媒体；为维护工程师提供有关信息系统的资料和知识库；为管理者提供项目计划、预算、开发进度等各方面的信息；作为最终用户手册或管理员手册，使用户知道如何使用、维护与管理系统

。711.1文档管理概述11.1.2文档管理工具WISS文档协同系统；DirectoryOpusforx64；

文管王文件管理系统；WordTools文档批量处理工具。711.1文档管理概述11.1.3文档与软件规模711.2文档的分类与作用11.2.1文档分类1.开发文档描述软件开发过程（包括软件需求、软件设计、软件测试、软件质量保证）的一类文档，也包括软件的详细技术描述（如程序逻辑、程序间相互关系、数据格式和存储等）。

软件需求规格说明书12

数据要求说明书详细设计说明书4可行性研究报告56

项目开发计划概要设计说明书3711.2文档的分类与作用11.2.1文档分类2.产品文档是描述开发过程的产物，规定关于软件产品的使用、维护、增强、转换和传输等信息，供用户、运行者和维护人员使用。培训手册12参考手册软件支持手册4产品手册56信息广告用户指南3711.2文档的分类与作用11.2.1文档分类3.管理文档从管理角度记录项目管理信息，这些信息包括：开发过程每个阶段的进度和进度变更记录、软件变更情况记录、相对于开发的判定记录及职责定义。项目开发计划12测试计划测试报告4开发进度月报56项目开发总结配置管理计划3711.2文档的分类与作用11.2.2文档作用

管理依据

任务之间联系的凭证

质量保证

培训与参考

软件维护支持

历史档案711.3文档编制要求1.基本要求制定计划，标识在软件产品生命周期期间产生的文档；每一种标识的文档应根据适用的文档编写标准进行编写；确认文档输入数据的来源。可以使用自动化的文档编写工具；按照文档编写标准的格式、技术内容和表达方式要求，评审和编辑产生的文档；按照计划产生和提供文档。文档的产生和发布可以使用纸张、电子媒体或其它媒体；按照配置管理过程进行控制；在修改文档时需要执行的任务应按照维护过程进行。711.3文档编制要求2.管理要求管理者严格要求软件开发人员和编制组完成文档编制，并且在策略、标准、规程、资源分配和编制计划方面给予支持。管理者对文档工作的责任；管理者对文档工作的支持；管理者的主要职责（6项）；项目管理者在项目开发前应决定的事项（7项）。711.4文档编制过程711.4文档编制过程开发文档活动应按照材料准备、文档计划、文档编制、文档编号、文档评审、文档签署、文档归档、文档保管和文档维护的逻辑顺序进行。711.4文档编制过程11.4.1材料准备

所有有关的规格说明、记录格式、屏幕和报告布局、CASE工具输出以及文档准备所需要的任何其它信息；

若可用，软件的操作副本；

软件分析员和程序员，能及时和确切地解答由文档开发人员提出的问题；

若可能，访问典型用户（为了做读者分析和可用性测试）。711.4文档编制过程11.4.2文档计划计划一般包括以下方面的内容：列出应编制文档的目录；提示编制文档参考的标准；指定文档管理员；提供编制文档所需要的条件；

明确保证文档质量的方法；绘制进度表；明确文档计划及文档的分发情况，访问典型用户。711.4文档编制过程11.4.3文档编号应按各单位规定的编号方法对软件文档进行编号，以便于管理。参考结构：XX

Y.YYYZZZWW-M单位代号（XX）：某单位的编号；十进分类特征标记（Y.YYY）：按产品的技术特征给出的标记；

登记顺序号（ZZZ）：由各单位标准化部门统一给定；文档简号（WW）：表示文档的名称，可按表11.1缩写简号；

媒体代号（M）：为区分源程序驻留的不同载体而给定的代号如表11.2所示。711.4文档编制过程711.4文档编制过程11.4.4文档评审评审通常采用评审会的方式进行，步骤如下：由软件开发单位负责人、用户代表、开发小组成员、科技管理人员和标准化人员等组成评审小组，必要时还可邀请外单位的专家参加；开会前，由开发单位负责人确定评审的具体内容，并将评审材料发给评审小组成员，做好评审准备；由开发单位负责人主持评审会，根据文档编制者对文档的说明和评审条目，由评审小组成员进行评议、评审，评审结束应做出评审结论，评审小组成员应在评审结论上签字。711.4文档编制过程11.4.4文档评审711.4文档编制过程11.4.5文档签署各签署者的技术责任如下：“编写”签署者，正确性、合理性、继承性、可靠性、完整性、一致性负责；“校对”签署者，与“编写”签署者负同等责任；“审核”签署者，设计方案选择的正确性、合理性，是否贯彻总体设计意图，设计结果或结论是否正确、全面，图例、术语、符号、公式、单位等是否贯彻标准和有关规定；“会签”签署者，正确性、合理性、完整性、协调性负责；“标准化”签署者，编写者是否贯彻先行标准和有关规章制度，软件文档的完整性和签署是否完整正确；“批准”签署者，功能、性能指标是否达到技术要求；软件文档的正确性、合理性和协调性；软件文档的完整性及设计质量；软件文档是否贯彻现行标准及有关规章制度。711.4文档编制过程11.4.6文档归档应将通过评审和签署的软件文档及时归档。归档的文档应包括整个软件生命周期内形成的全部文档。文档归档应满足如下条件：归档的文档应是经过鉴定或评审的；

文档应签署完整、成套、格式统一、字迹工整；印制本、打印本以及各种报告应装订成册，并按规定进行编号和签署。软件文档应在软件开发过程每个阶段结束后及时归档。711.4文档编制过程11.4.7文档保管通常应在不同地点建立设施来保存重要文档副本；如果文档是联机开发的，则应将它存储到磁带或磁盘上，以便能够迅速将这些文档转换成可用的形式；文档保管包括登记、保存、借阅和修改等四项工作；文档保管应按国家和上级主管部门的要求，以及各单位的规章制度规定执行。711.4文档编制过程11.4.8文档维护软件产品完成后，确定软件维护人员；软件运行过程中，记录从用户或其它途径反馈回来的软件质量信息；在分析整理后，按照GB/T8567的要求填写“问题报告单”；根据“问题报告单”中提出的要求，填写“修改申请报告”；根据申请批准的“修改申请报告”，对程序进行修改和测试；测试通过后，填写“软件修改报告”，并修改相应的文档和媒体；将“软件修改报告”和修改后的文档送校对、审核、会签、标准化和批准等有关负责人审阅和签署；修改后的文档、媒体和“软件修改报告”送交档案管理部门存档；软件维护人员汇总并整理修改的情况，编写“软件维护通报”。711.5文档编制11.5.1编制策略文档需要覆盖整个软件生命周期文档应是可管理的文档应适合于其读者文档作用应贯穿软件整个开发过程文档标准应被标识和使用应规定支持工具711.5文档编制11.5.2文档标准过程标准产品标准过程标准定义了书写文档的方法。这些通用方法规定了书写文档时要采用的软件工具，同时也定义了为确保高质量文档的质量确保程序。产品标准适用于在软件开发过程中所有产生的文档。文档应该有一个统一的外观，并且同一种类的文档应该有统一的结构。交互标准在软件项目开发过程中，软件工程师之间的交流途径更多采用电子化方式而不是纸质文件，文档交互标准就变得越来越重要。711.5文档编制11.5.3质量等级最低限度文档（1极文档）适合开发工作量低于一个人月的开发者自用程序。应包含程序清单、开发记录、测试数据和程序简介；内部文档（2极文档）用于在精心研究后被认为似乎没有与其他用户共享资源的专用程序。除1级文档提供的信息外，还包括程序清单内足够的注释；工作文档（3极文档）适合于由同一单位内若干人联合开发的程序，或可被其它单位使用的程序；最低限度文档（1极文档）适合要正式发行可供普遍使用的软件产品。关键性程序或具有重复管理应用程序需要4级文档。4级文档遵守GB8567的有关规定。711.5文档编制11.5.4质量要求针对性12精确性重复性5灵活性（见下页）67可追溯性及时性3完整性4711.5文档编制11.5.4质量要求灵活性包括：应编制的文档种类；文档的详细程度；文档扩展；章、条的扩张与缩并；程序设计的表现形式；文档的表现形式；文档的其它种类。71.5文档编制1.5.5书写风格文档层次12

注释说明