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