《[互联网]ch09-IT软件项目文档管理课件》由会员分享，可在线阅读，更多相关《[互联网]ch09-IT软件项目文档管理课件（37页珍藏版）》请在金锄头文库上搜索。
1、武汉科技大学 汪勇 第第9 9章章 ITIT软件项目文档管理软件项目文档管理 9 9.1 .1 文档管理概述文档管理概述 9.2 9.2 项目文档的撰写项目文档的撰写 9.3 9.3 文档的管理和维护文档的管理和维护9.4 9.4 主要项目文档主要项目文档 武汉科技大学 汪勇 9.1.1 9.1.1 文档管理的概念文档管理的概念9.1.2 9.1.2 项目文档的分类项目文档的分类9.1.3 9.1.3 文档管理与文档管理与SCMSCM、CMMCMM关系关系9 9.1 .1 文档管理文档管理概述概述武汉科技大学 汪勇 （1 1）文档文档 文档是软件项目开发应用的一部分，存在于软件文档是软件
2、项目开发应用的一部分，存在于软件项目的整个生命周期之中。项目的整个生命周期之中。 没有正式文档的软件项目开发，就不是规范标准没有正式文档的软件项目开发，就不是规范标准的软件项目。的软件项目。 文档缺陷是软件缺陷的一种表现形式，如果按照文档缺陷是软件缺陷的一种表现形式，如果按照带有缺陷的文档进行操作，会造成不良的后果，甚至带有缺陷的文档进行操作，会造成不良的后果，甚至带来损失。在实际工作中因文档质量不高，造成软件带来损失。在实际工作中因文档质量不高，造成软件投产后出现系统宕机、账务错误等时有发生。投产后出现系统宕机、账务错误等时有发生。9 9.1.1 .1.1 文档管理文档管理的概念的概念武汉科
3、技大学 汪勇 （2 2）文档管理文档管理 文档管理就是按照一定的标准高质量、高效率地文档管理就是按照一定的标准高质量、高效率地设计和编制文档，按照规范分发、维护、转让、变更、设计和编制文档，按照规范分发、维护、转让、变更、修正、扩充和使用文档，提高软件项目的质量和客户修正、扩充和使用文档，提高软件项目的质量和客户满意度。满意度。 文档的编制和管理在软件项目开发中占有突出的文档的编制和管理在软件项目开发中占有突出的地位和相当大的工作量。地位和相当大的工作量。9 9.1.1 .1.1 文档管理文档管理的概念的概念武汉科技大学 汪勇 （3 3）文档管理的作用文档管理的作用n能作为开发组员之间交流
4、沟通的媒介能作为开发组员之间交流沟通的媒介n能为软件项目的维护工程师提供有关信息系统的能为软件项目的维护工程师提供有关信息系统的资料资料n能为项目管理者提供项目计划、预算、开发进度能为项目管理者提供项目计划、预算、开发进度等各方面的信息等各方面的信息n能作为最终用户或管理员的用户手册，使用户知能作为最终用户或管理员的用户手册，使用户知道如何使用、维护及管理系统道如何使用、维护及管理系统9 9.1.1 .1.1 文档管理文档管理的概念的概念武汉科技大学 汪勇 9 9.1.2 .1.2 项目文档项目文档的分类的分类项目文档项目文档过程文档过程文档产品文档产品文档管理文档管理文档系统文档系统文档用
5、户文档用户文档图图9.1 9.1 项目文档分类项目文档分类武汉科技大学 汪勇 （1 1）过程文档）过程文档 是指那些记录软件项目开发和维护过程的文档是指那些记录软件项目开发和维护过程的文档资料。项目的计划、进度、过程质量、组织及项目资料。项目的计划、进度、过程质量、组织及项目标准等都是过程文档。标准等都是过程文档。9 9.1.2 .1.2 项目文档项目文档的分类的分类武汉科技大学 汪勇 n过程文档分类过程文档分类n计划文档：由项目经理负责产生，以便预测和控制计划文档：由项目经理负责产生，以便预测和控制软件的开发过程。软件的开发过程。n相关报告：项目执行过程中产生的一组文档，是不相关报告：项
6、目执行过程中产生的一组文档，是不同阶段的工作成果之一。同阶段的工作成果之一。n标准报告：规定了软件过程应该如何实现，这些可标准报告：规定了软件过程应该如何实现，这些可以是国际标准、国家标准、行业标准等。以是国际标准、国家标准、行业标准等。n工作文档：在项目开发中最主要的交流沟通工具，工作文档：在项目开发中最主要的交流沟通工具，记录了软件项目开发中软件工程师的想法等。记录了软件项目开发中软件工程师的想法等。9 9.1.2 .1.2 项目文档项目文档的分类的分类武汉科技大学 汪勇 9 9.1.2 .1.2 项目文档项目文档的分类的分类n过程文档作用过程文档作用n它们是软件开发过程中包含的所有阶段
7、之间的通它们是软件开发过程中包含的所有阶段之间的通信工具，记录生成软件需求、分析、设计、编码信工具，记录生成软件需求、分析、设计、编码和测试、维护的详细规定和说明。和测试、维护的详细规定和说明。n描述开发小组的职责。描述开发小组的职责。n用作检查和控制软件开发过程。如果开发文档丢用作检查和控制软件开发过程。如果开发文档丢失、不完整或过时，管理者将失去跟踪和控制软失、不完整或过时，管理者将失去跟踪和控制软件项目的一个重要工具。件项目的一个重要工具。 武汉科技大学 汪勇 （2 2）产品文档）产品文档 产品文档是描述正在开发的产品的资料。产品文产品文档是描述正在开发的产品的资料。产品文档可以分为档
8、可以分为用户文档用户文档和和系统文档。系统文档。 n产品文档作用产品文档作用n为使用和运行软件产品的任何人规定培训和参为使用和运行软件产品的任何人规定培训和参考信息。考信息。 n使得那些未参加开发本软件的程序员维护它。使得那些未参加开发本软件的程序员维护它。 n促进软件产品的市场流通或提高可接受性。促进软件产品的市场流通或提高可接受性。 9 9.1.2 .1.2 项目文档项目文档的分类的分类武汉科技大学 汪勇 n主要的用户文档主要的用户文档n系统安装手册系统安装手册n用户操作手册用户操作手册n系统管理员手册系统管理员手册9 9.1.2 .1.2 项目文档项目文档的分类的分类n主要的系统文档主
9、要的系统文档n系统体系结构文档系统体系结构文档n子系统的规范和设计说明书子系统的规范和设计说明书n程序代码列表程序代码列表n维护指导文档维护指导文档武汉科技大学 汪勇 系统管理员向导系统评估员功能性描述描述提供的服务系统管理员安装描述怎样安装系统新用户初级使用手册如何开始使用系统老用户参考手册所有系统功能的详细描述系统管理员如何操作和维护系统图图9.2 9.2 需要随软件系统发布而产生的部分用户文档需要随软件系统发布而产生的部分用户文档9 9.1.2 .1.2 项目文档项目文档的分类的分类武汉科技大学 汪勇 9 9.1.2 .1.2 项目文档项目文档的分类的分类 （3 3）管理文档）管理文
10、档 这种文档建立在项目管理信息的基础上，诸如：这种文档建立在项目管理信息的基础上，诸如： 每个阶段的进度、成本、变更等记录每个阶段的进度、成本、变更等记录 软件变更情况的记录软件变更情况的记录 会议记录会议记录 职责定义职责定义 武汉科技大学 汪勇 （1）文档管理文档管理与与SCM关系关系 不同阶段的文档有不同的版本，它是软件配置项不同阶段的文档有不同的版本，它是软件配置项之一，置于配置管理之下。之一，置于配置管理之下。（2）文档管理文档管理与与CMM关系关系 文档管理是文档管理是CMMCMM模型中模型中级（已确定级）的要求。级（已确定级）的要求。CMM-CMM-级中规定：软件开发活动的过程
11、在管理活动、级中规定：软件开发活动的过程在管理活动、技术活动和支持活动等方面都已文档化、规范化。所技术活动和支持活动等方面都已文档化、规范化。所有项目或产品的开发和维护都在这个规范化的体系基有项目或产品的开发和维护都在这个规范化的体系基础上进行定制。础上进行定制。9 9.1.3 .1.3 文档管理文档管理与与SCMSCM、CMMCMM关系关系武汉科技大学 汪勇 9.2.1 9.2.1 文档编制标准文档编制标准9.2.2 9.2.2 项目文档结构项目文档结构 9.2.3 9.2.3 文档撰写流程文档撰写流程 9.2.4 9.2.4 文档书写风格文档书写风格9 9.2 .2 项目文档项目文档的撰
12、写的撰写武汉科技大学 汪勇 GB 8566-88 GB 8566-88 计算机软件开发规范计算机软件开发规范GB 8567-88 GB 8567-88 计算机软件产品开发文件编制指计算机软件产品开发文件编制指GB/T 11457-1995 GB/T 11457-1995 软件工程术语软件工程术语主要的文档标准见附件主要的文档标准见附件“软件开发文档标准软件开发文档标准” ” 9 9.2.1 .2.1 文档文档编制标准编制标准武汉科技大学 汪勇 9 9.2.2 .2.2 项目文档项目文档结构结构（1 1）文档封面）文档封面 密级：机密机密 文档编号： 第 版 中视传媒AIMS2008 文档名
13、称文档名称 武汉科技大学图图9.3 9.3 项目文档封面的主要信息项目文档封面的主要信息总页数正文附录日期：编制审核批准：武汉科技大学 汪勇 9 9.2.2 .2.2 项目文档项目文档结构结构（2）文档内容结构）文档内容结构目录目录正文正文 a) a) 提示编制文档应参考的标准提示编制文档应参考的标准 b) b) 文档编写人员、指定文档管理员文档编写人员、指定文档管理员 c) c) 提供编制文档所需要的条件提供编制文档所需要的条件 d d）编制工具）编制工具 d) d) 明确保证文档质量的方法明确保证文档质量的方法 e e）文档详细内容）文档详细内容附件附件图图9.4 9.4 项目文档内容结
14、构项目文档内容结构武汉科技大学 汪勇 阶段2：修改阶段1：编制编写最初文档评审文档整理评审意见修改文档校对文字最终文档确认最终文档设计文档复审文档打印文档打印备份文档阶段3：发布图图9.5 9.5 文档编制过程文档编制过程9 9.2.3 .2.3 文档文档撰写流程撰写流程武汉科技大学 汪勇 n语气：运用主动的而不是被动的语气语气：运用主动的而不是被动的语气 n术术语语：运运用用正正确确的的术术语语和和语语法法结结构构，简简明明定定义用到的专业术语义用到的专业术语 n简洁：尽量用短句，段落简短，用词简洁简洁：尽量用短句，段落简短，用词简洁n标题：应用标题和子标题标题：应用标题和子标题 n格式
15、：所有文档格式统一格式：所有文档格式统一n说说明明和和注注释释：不不要要单单纯纯地地以以数数字字、图图、表表来来理解信息，应当有一定的说明和注释理解信息，应当有一定的说明和注释编写文档时，应该注意以下问题：编写文档时，应该注意以下问题：9 9.2.4 .2.4 文档文档书写风格书写风格武汉科技大学 汪勇 9 9.3 .3 文档文档的管理和维护的管理和维护9.3.1 9.3.1 制定制定文档文档管理计划管理计划9.3.2 9.3.2 制定文档管理办法制定文档管理办法9.3.3 9.3.3 文档管理流程文档管理流程9.3.4 9.3.4 建立文档管理系统建立文档管理系统武汉科技大学 汪勇 项目
16、管理者在项目开发前应决定如下事项：项目管理者在项目开发前应决定如下事项： 要求哪些类型的文档；要求哪些类型的文档； 文档包含的内容；文档包含的内容； 达到何种级别的质量水平；达到何种级别的质量水平； 何时产生何种文档；何时产生何种文档； 如何保存、维护文档以及如何进行通信。如何保存、维护文档以及如何进行通信。 9 9.3.1 .3.1 制定文档制定文档管理计划管理计划武汉科技大学 汪勇 （1 1）管理者的职责）管理者的职责 确定和准备各种标准和指南；确定和准备各种标准和指南； 建立编制、登记、出版文档的各种策略；建立编制、登记、出版文档的各种策略； 建立确定文档质量的各种方法的规程；建立确定
17、文档质量的各种方法的规程； 负责分发、收集、保管各类文档。负责分发、收集、保管各类文档。 积极支持文档工作，形成在开发工作中自觉编制积极支持文档工作，形成在开发工作中自觉编制文档的团队风气；文档的团队风气； 9 9.3.2 .3.2 制定文档管理办法制定文档管理办法武汉科技大学 汪勇 9 9.3.2 .3.2 制定文档管理办法制定文档管理办法（2 2）文档文档管理办法管理办法 项目组应设一位文档管理人员，负责集中保管本项项目组应设一位文档管理人员，负责集中保管本项 目已有文档。目已有文档。 项目组的成员可根据工作需要在自己手中保存主文项目组的成员可根据工作需要在自己手中保存主文 本中与他工作
18、相关的部分文档作为个人文档。这些本中与他工作相关的部分文档作为个人文档。这些 一般都应是主文本的复制件。一般都应是主文本的复制件。 主文本的修改必须特别谨慎。修改以前要充分估计主文本的修改必须特别谨慎。修改以前要充分估计 修改可能带来的影响，并且要按照：提议、评议、修改可能带来的影响，并且要按照：提议、评议、 审核、批准和实施等步骤加以严格的控制。审核、批准和实施等步骤加以严格的控制。 在新文档取代了旧文档时，文档管理员应及时注销在新文档取代了旧文档时，文档管理员应及时注销 旧文档，使其及时反映更新了的内容。旧文档，使其及时反映更新了的内容。 项目开发结束时，文档管理员应收回个人文档。项目开发
19、结束时，文档管理员应收回个人文档。武汉科技大学 汪勇 9 9.3.3 .3.3 文档管理流程文档管理流程图图9.6 9.6 项目文档管理流程项目文档管理流程文档版本管理文档版本管理文档分发与保管文档分发与保管制定文档编制计划制定文档编制计划编制文档编制文档验收正式文档验收正式文档文档执行文档执行项目管理者项目管理者项目开发者项目开发者项目开发者项目开发者文档管理者文档管理者文档管理者文档管理者文档管理者文档管理者武汉科技大学 汪勇 文档索引文档索引文档管理系统文档管理系统配置管理系统配置管理系统文档参考用户请求图图9.7 9.7 文档管理系统文档管理系统文档数据库文档数据库9 9.3.4
20、.3.4 建立文档建立文档管理系统管理系统武汉科技大学 汪勇 9.4.1 9.4.1 立项报告立项报告9.4.2 9.4.2 可行性研究报告可行性研究报告9.4.3 9.4.3 项目计划书项目计划书9.4.4 9.4.4 项目分析报告项目分析报告9.4.5 9.4.5 项目设计报告项目设计报告9.4.6 9.4.6 程序设计报告程序设计报告9.4.7 9.4.7 项目测试报告项目测试报告9.4.8 9.4.8 项目使用与维护手册项目使用与维护手册9.4.9 9.4.9 项目评价报告项目评价报告9.4.10 9.4.10 项目总结报告项目总结报告 9 9.4 .4 主要项目文档主要项目文档武汉
21、科技大学 汪勇 (1) (1) 开发背景开发背景(2) (2) 现行系统存在的主要问题现行系统存在的主要问题(3) (3) 新系统的目标新系统的目标(4) (4) 经费预算和经费来源经费预算和经费来源(5) (5) 项目进度和完成期限项目进度和完成期限(6) (6) 验收标准和方法验收标准和方法(7) (7) 移交的文档资料移交的文档资料(8) (8) 可行性研究的组织可行性研究的组织(9) (9) 其他需要说明的有关问题其他需要说明的有关问题9 9.4.1 .4.1 立项报告立项报告武汉科技大学 汪勇 (1) (1) 系统概述系统概述(2) (2) 新系统的要求和约束新系统的要求和约束(
22、3) (3) 可行性研究的基本准则可行性研究的基本准则(4) (4) 新系统目标与方案新系统目标与方案(5) (5) 可行性分析可行性分析 管理现状研究、技术分析、投资与效益分析管理现状研究、技术分析、投资与效益分析(6) (6) 其他可选方案及国内外同类方案的比较其他可选方案及国内外同类方案的比较(7) (7) 可行性研究结论可行性研究结论(8) (8) 有关建议有关建议9 9.4.2 .4.2 可行性研究报告可行性研究报告武汉科技大学 汪勇 具体参见具体参见5.65.6节。节。9 9.4.3 .4.3 项目项目计划书计划书武汉科技大学 汪勇 (1) (1) 概述概述(2) (2) 系统
23、功能分析系统功能分析(3) (3) 业务流程分析业务流程分析(4) (4) 数据流程分析数据流程分析9 9.4.4 .4.4 项目项目分析报告分析报告武汉科技大学 汪勇 (1) (1) 系统概述系统概述(2) (2) 系统总体结构系统总体结构(3) (3) 计算机系统配置方案计算机系统配置方案(4) (4) 代码设计代码设计(5) (5) 文件文件/ /数据库设计数据库设计(6) (6) 输入输出设计输入输出设计(7) (7) 计算机处理过程设计计算机处理过程设计(8) (8) 接口及通信环境设计接口及通信环境设计(9) (9) 安全保密设计安全保密设计(10) (10) 数据准备数据准备(
24、11) (11) 系统测试计划系统测试计划(12) (12) 培训计划培训计划9 9.4.5 .4.5 项目项目设计报告设计报告武汉科技大学 汪勇 (1) (1) 概述概述(2) (2) 程序结构图程序结构图(3) (3) 程序控制图程序控制图(4) (4) 算法算法(5) (5) 程序流程图程序流程图(6) (6) 源程序源程序(7) (7) 程序注释及说明程序注释及说明9 9.4.6 .4.6 程序设计程序设计报告报告武汉科技大学 汪勇 (1) (1) 概述：说明项目测试的目的。概述：说明项目测试的目的。(2) (2) 测试环境：有关软、硬件、通信、数据库、人员测试环境：有关软、硬件、
25、通信、数据库、人员 等情况。等情况。(3) (3) 测试内容：系统、子系统、模块的名称、性能技测试内容：系统、子系统、模块的名称、性能技 术指标等。术指标等。(4) (4) 测试方案：测试的方法、测试数据、测试步骤、测试方案：测试的方法、测试数据、测试步骤、 测试中故障的解决方案等。测试中故障的解决方案等。(5) (5) 测试结果：测试的实际情况。测试结果：测试的实际情况。(6) (6) 结论：项目功能评价、性能技术指标评价、结结论：项目功能评价、性能技术指标评价、结 论。论。9 9.4.7 .4.7 项目项目测试报告测试报告武汉科技大学 汪勇 (1) (1) 概述：主要包括系统功能、系统运
26、行环境概述：主要包括系统功能、系统运行环境( (软软 硬件环境硬件环境) )、系统安装等内容。、系统安装等内容。(2) (2) 使用说明：系统操作使用说明较为详细地说明使用说明：系统操作使用说明较为详细地说明 了操作的目的、过程、方式、输入输出的数据了操作的目的、过程、方式、输入输出的数据 等。最好将系统操作的界面图放入说明书中，等。最好将系统操作的界面图放入说明书中， 便于使用者学习与操作。便于使用者学习与操作。(3) (3) 问题解释：解释了系统使用中可能出现的问题问题解释：解释了系统使用中可能出现的问题 及解决办法，如非常规操作命令、系统恢复过及解决办法，如非常规操作命令、系统恢复过 程
27、及意外情况、与开发单位的联系方式等程及意外情况、与开发单位的联系方式等。9 9.4.8 .4.8 项目项目使用与维护手册使用与维护手册武汉科技大学 汪勇 (1) (1) 概述概述(2) (2) 系统构成系统构成(3) (3) 系统达到设计目标的情况系统达到设计目标的情况(4) (4) 系统的可靠性、安全性、保密性、可维护系统的可靠性、安全性、保密性、可维护 性等状况性等状况(5) (5) 系统的经济效益与社会效益的评价系统的经济效益与社会效益的评价(6) (6) 总结性评价总结性评价9 9.4.9 .4.9 项目项目评价报告评价报告武汉科技大学 汪勇 (1) (1) 概述：包括项目的提供者
28、、开发者、用户；项概述：包括项目的提供者、开发者、用户；项 目开发的主要依据；项目开发的目的；项目开目开发的主要依据；项目开发的目的；项目开 发的可行性分析等。发的可行性分析等。(2) (2) 项目的完成情况：包括项目构成与主要功能；项目的完成情况：包括项目构成与主要功能； 项目性能与技术指标；计划与实际进度对比；项目性能与技术指标；计划与实际进度对比； 费用预算与实际费用的对比等。费用预算与实际费用的对比等。(3) (3) 项目评价：项目的主要特点；采用的技术方法项目评价：项目的主要特点；采用的技术方法 与评价；项目工作效率与质量；存在的问题与与评价；项目工作效率与质量；存在的问题与 原因；用户的评价与反馈意见。原因；用户的评价与反馈意见。(4) (4) 经验与教训：项目开发过程中的经验与教训；经验与教训：项目开发过程中的经验与教训； 对今后工作的建议；写出对外发表的论文对今后工作的建议；写出对外发表的论文。9 9.4.10 .4.10 项目项目开发总结报告开发总结报告
