IT软件项目管理ch10

it 软件项目管理

第 10 章IT软件项目文档管理 (1次、2课时)

it 软件项目管理

第10章 IT软件项目文档管理软件项目文档管理概述 项目文档的质量 项目文档准备 主要项目文档 思考题

10.1 10.2 10.3 10.4 10.5

it 软件项目管理

10.1 软件项目文档管理概述

10.1.1 10.1.2 10.1.3 10.1.4

项目文档管理的概念 项目文档的分类 过程文档 产品文档

it 软件项目管理

10.1.1 项目文档管理的概念概念属性：

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

it 软件项目管理

10.1.2 项目文档的分类文档可分为以下两大类，即过程文档和产品文档 ：

过程文档，是指那些记录软件项目开发和维护过程 的文档资料，项目的计划、进度、过程质量、组织 及项目标准等都是过程文档。 产品文档，是那些描述正在开发的产品的资料。这 类文档又可以分为从软件工程师开发和维护系统的 角度描述产品的系统文档，以及主要以客户为对象 描述产品的用户文档。

it 软件项目管理

10.1.3 过程文档过程文档可以分为如下几类：

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

it 软件项目管理

10.1.4 产品文档产品文档可以分为用户文档和系统文档：

用户文档包括：

(1) (2) (3) (4) (5)

系统功能描述 初级使用手册 系统参考手册 系统安装文档 系统管理员手册

it 软件项目管理

10.1.4 产品文档

系统评估员

系统管理员

新用户

老用户

系统管理员

功能性描述

安装描述

初级使用手册

参考手册

系统管理员向导

描述提供 的服务

怎样安 装系统

如何开始 使用系统

所有系统功能 的详细描述

如何操作和 维护系统

图10.1 需要随软件系统发布而产生的部分用户文档

it 软件项目管理

10.1.4 产品文档系统文档包括：

需求文档及相关的基本原理说明。 系统体系结构文档。 对系统的每一个程序，都有相应的程序体系结构文档。 每个子系统的规范和设计说明书。 程序代码列表。这些列表包括程序注释、用来

解释代码中复杂 代码段和采用的编码方法等。 描述每个程序怎样验证和验证信息与需求之间关系的验证文档。 维护指导文档，主要描述系统已知的问题、软件支持、硬件支 持等信息，以便维护时使用。

it 软件项目管理

10.2 项目文档的质量

10.2.1 项目文档结构 10.2.2 文档标准 10.2.3 文档书写风格

it 软件项目管理

10.2.1 项目文档结构主要信息：标题： 项目： 文档ID: 文档类型： 版本： 作者： 是否被检查： 是/否 提交给CM: 发布： 密级： 关键词：

日期： 是否被同意：N/A CM _ID:

图10.2 项目文档封面的主要信息

it 软件项目管理

10.2.2 文档标准包括：

过程标准：这种标准定义了高质量文档应该 遵守的过程。 产品标准：这种标准操纵文档本身。 交互标准：通过电子邮件和文档数据库交换 文档变得越来越重要，交互标准使得所有的 文档都存在可比性。

it 软件项目管理

10.2.2 文档标准

编写最初文档阶段1:编制

评审文档

整理评审意见

修改文档

校对文字阶段2:修改 设计文档 阶段3:发布 复审文档

最终文档

确认最终文档

打印文档

打印备份文档

图10.3 文档编制过程

it 软件项目管理

10.2.3 文档书写风格编写文档时，也应该注意以下问题：

运用主动的而不是被动的语气。 运用正确的术语和语法结构。 句子不宜过长，尽量用短句。 段落简短。 用词简洁，不要长篇累犊。 简明定义用到的专业术语。 应用标题和子标题。 尽可能地逐条列举事实。 不要单纯地参考数字、图、表来理解信息，应当有一 定的说明和注释。

it 软件项目管理

10.3 项目文档准备文档的准备分3个阶段 ：

文档制作：文字处理器、文本格式器、表格 和公式编辑器、绘图工具包等。 文档修改：拼写检查器和风格检查器。 文档产品发布：桌面发布包、技术工作包等。

it 软件项目管理

10.3 项目文档准备文档管理系统 ：

用户请求 文档管理系统 文档参考 配置管理系统

文档索引

文档数据库 图10.4 文档管理