第10章IT软件项目文档管理.ppt

第10章 IT软件项目文档管理 10.1 软件项目文档管理概述 10.2 项目文档的质量 10.3 项目文档准备 10.4 主要项目文档 10.1 软件项目文档管理概述 10.1.1 项目文档管理的概念 10.1.2 项目文档的分类 10.1.3 过程文档 10.1.4 产品文档 10.1.1 项目文档管理的概念 能作为开发组员之间交流沟通的媒介。 能为软件项目的维护工程师提供有关信息系统的资料和知识库。 能为项目管理者提供项目计划、预算、开发进度等各方面的信息。 能作为最终用户或管理员的用户手册，使用户知道如何使用、维护及管理系统。 10.1.2 项目文档的分类 过程文档：是指那些记录软件项目开发和维护过程的文档资料，项目的计划、进度、过程质量、组织及项目标准等都是过程文档。 产品文档：是那些描述正在开发的产品的资料。这类文档又可以分为从软件工程师开发和维护系统的角度描述产品的系统文档，以及主要以客户为对象描述产品的用户文档。 编写过程文档的主要目的在于所开发的产品能被很好地管理。产品文档一般在系统运行后才开始使用，同时它也对管理系统开发工作必不可少。不同时期编写的文档代表在软件开发过程中的一个重要阶段里程碑。 10.1.3 过程文档（1） 软件项目计划、预测和进度安排文档：这些文档由项目经理负责产生，以便预测和控制软件的开发过程。 相关报告：这些文档用来报告在软件开发过程中，资源是如何分配和利用的。 标准报告：这些文档规定了软件过程应该如何实现，这些可以是国际标准、国家标准、行业标准等。 工作文档：这些文档是在项目开发中最主要的交流沟通工具，记录了软件项目开发中软件工程师的想法等。 备忘录及电子信息：主要记录了每天项目经理和开发人员之间的详细交流信息。 10.1.3 过程文档（2） 过程文档的最大特点是：大部分文档都是已经过时了的。过程文档主要是软件项目开发过程中的各种事件和信息的记录。 在过程文档中，计划可以是由周计划、日计划或月计划组成，进度一般以周为单位进行报告，记录软件工程师的想法和目的备忘录将不断被改变。 大多数信息在过时后将没有多少使用价值，一般也就没有再保存的必要，但也有例外，如测试计划等在软件开发过程中具有保存的价值，它是系统变更的基础；设计报告也具有保存的价值，它为维护系统提供依据等。 10.1.4 产品文档（1） 产品文档主要描述已交付的软件产品情况，与大多数过程文档不同，产品文档有很长的生命周期，它必须随着产品一步步发展。 产品文档可以分为用户文档和系统文档 用户文档以文档资料形式告诉用户如何利用该系统； 系统文档主要为维护工程师服务。 在软件项目中，软件的用户并不完全相同，不同用户面向的文档也不一样，因此，在编辑文档时，必须将最终用户和系统管理员区分开。 最终用户主要是使用软件来完成一定的任务。他们只关心如何利用软件来帮助他们完成工作，不关心计算机和软件管理上其他细节。 系统管理员负责管理最终用户使用的软件。 10.1.4 产品文档（2） 10.1.4 产品文档（3）——用户文档 系统功能描述：简要描述系统的需求和提供的服务。该文档为系统提供一个总体的概念描述。用户通过阅读该文档，可以确定是不是他们所需要的系统。 初级使用手册：为系统提供一个非正式的介绍，描述一些“常规”的使用操作。 系统参考手册：描述系统的功能设施及其用途，能为错误信息提供一个完整的列表，并且描述怎样从发现的错误中恢复。系统参考手册应该是完整的和正式的。 系统安装文档：一般面向系统管理员，为系统管理员提供在特定环境下如何安装系统的详细说明。 系统管理员手册：主要提供当系统与其他系统交互时所产生的信息，及如何对这些信息进行反应的说明。 10.1.4 产品文档（4）——系统文档 系统文档包括所有描述系统是如何从需求报告到最终变成可接受的系统过程中，与分析、设计、实施等方面有关的技术文档。 系统文档主要包括： 需求文档及相关的基本原理说明。 系统体系结构文档。 对系统的每一个程序，都有相应的程序体系结构文档。 每个子系统的规范和设计说明书。 程序代码列表。这些列表包括程序注释、用来解释代码中复杂代码段和采用的编码方法等。 描述每个程序怎样验证和验证信息与需求之间关系的验证文档。 维护指导文档，主要描述系统已知的问题、软件支持、硬件支持等信息，以便维护时使用。 10.2 项目文档的质量 10.2.1 项目文档结构 10.2.2 文档标准 10.2.3 文档书写风格 10.2.1 项目文档结构（1） 文档的内容决定了文档的结构，文档结构随项目不同而不同，但一般都要符合以下的基本原则： 所有文档（不论大小、长短）都应该有封面，用来标识该项目文档的作者、制作时间、文