IT软件项目文档管理课件.pptx

第10章IT软件项目文档管理10.1软件项目文档管理概述10.2项目文档的质量10.3项目文档准备10.4主要项目文档2024/7/6上海海事大学计算机系1

10.1软件项目文档管理概述10.1.1项目文档管理的概念10.1.2项目文档的分类10.1.3过程文档10.1.4产品文档2024/7/6上海海事大学计算机系2

10.1.1项目文档管理的概念1.文档的地位是IT软件项目开发中的重要组成部分对于项目开发的成功和项目的正常维护起着重要的保证和支持作用2.项目文档的特点任何项目都有数量众多的文档一般：文档数量的多少、规模的大小、结构的复杂程度与所开发软件的大小和复杂程度成正比开发成本一大部分发生在文档的编制和准备过程中2024/7/6上海海事大学计算机系3

3.文档的作用能作为开发组员之间交流沟通的媒介。能为软件项目的维护工程师提供有关信息系统的资料和知识库。能为项目管理者提供项目计划、预算、开发进度等各方面的信息。能作为最终用户或管理员的用户手册，使用户知道如何使用、维护及管理系统。2024/7/6上海海事大学计算机系4

10.1.2项目文档的分类1.分类：文档可分为以下两大类，即过程文档和产品文档过程文档：是指那些记录软件项目开发和维护过程的文档资料，项目的计划、进度、过程质量、组织及项目标准等都是过程文档。产品文档：是那些描述正在开发的产品的资料。这类文档又可以分为从软件工程师开发和维护系统的角度描述产品的系统文档，以及主要以客户为对象描述产品的用户文档。2024/7/6上海海事大学计算机系5

2.编写过程文档目的：在于所开发的产品能被很好地管理产品文档一般在系统运行后才开始使用，同时它也对管理系统开发工作必不可少不同时期编写的文档代表在软件开发过程中的一个重要阶段里程碑。2024/7/6上海海事大学计算机系6

10.1.3过程文档（1）1.分类：软件项目计划、预测和进度安排文档：这些文档由项目经理负责产生，以便预测和控制软件的开发过程。相关报告：这些文档用来报告在软件开发过程中，资源是如何分配和利用的。标准报告：这些文档规定了软件过程应该如何实现，这些可以是国际标准、国家标准、行业标准等。工作文档：这些文档是在项目开发中最主要的交流沟通工具，记录了软件项目开发中软件工程师的想法等。备忘录及电子信息：主要记录了每天项目经理和开发人员之间的详细交流信息。2024/7/6上海海事大学计算机系7

2.过程文档特点：大部分文档都是已经过时了的。过程文档主要是软件项目开发过程中的各种事件和信息的记录。计划可以是由周计划、日计划或月计划组成，进度一般以周为单位进行报告，记录软件工程师的想法和目的备忘录将不断被改变。大多数信息在过时后将没有多少使用价值，一般也就没有再保存的必要，但也有例外，如测试计划等在软件开发过程中具有保存的价值，它是系统变更的基础；设计报告也具有保存的价值，它为维护系统提供依据等。2024/7/6上海海事大学计算机系8

10.1.4产品文档（1）1.特点：产品文档主要描述已交付的软件产品情况与过程文档不同，产品文档有很长的生命周期必须随着产品一步步发展2.分类产品文档可以分为用户文档和系统文档用户文档以文档资料形式告诉用户如何利用该系统系统文档主要为维护工程师服务2024/7/6上海海事大学计算机系9

3.注意：在软件项目中，软件的用户并不完全相同，不同用户面向的文档也不一样，必须产生不同的文档来适应不同的任务和水平的用户在编辑文档时，必须将最终用户和系统管理员区分开最终用户主要是使用软件来完成一定的任务。他们只关心如何利用软件来帮助他们完成工作，不关心计算机和软件管理上其他细节系统管理员负责管理最终用户使用的软件……2024/7/6上海海事大学计算机系10

10.1.4产品文档（2）2024/7/6上海海事大学计算机系11系统管理员向导系统评估员功能性描述描述提供的服务系统管理员安装描述怎样安装系统新用户初级使用手册如何开始使用系统老用户参考手册所有系统功能的详细描述系统管理员如何操作和维护系统图10.1需要随软件系统发布而产生的部分用户文档

10.1.4产品文档（3）4.用户文档系统功能描述：简要描述系统的需求和提供的服务。该文档为系统提供一个总体的概念描述。用户通过阅读该文档，可以确定是不是他们所需要的系统。初级使用手册：为系统提供一个非正式的介绍，描述一些“常规”的使用操作。系统参考手册：描述系统的功能设施及其用途，能为错误信息提供一个完整的列表，并且描述怎样从发现的错误中恢复。系统参考手册应该是完整的和正式的。2024/7/6上海海事大学计算机系12

系统安装文档：一般面向系统管理员，为系统管