（工商管理专业论文）IT项目中的文档管理.pdf

it 项目中的文档管理 摘要 随着i t 行业在中国的迅猛发展，很多企业在项目管理的方方面面存在着 或多或少的问题。文档管理就是存在着许多问题的项目管理方面之一。本文 从对中国i t 企业中项目的文档管理的调查入手，研究和分析了目前我国i t 企业项目中的文档管理的现状。试图通过运用软件能力成熟度( c m m ) 理论 框架，结合中国企业的现状，提出i t 项目中的文档管理的框架、流程以及具 体实施过程中运用的方法。 关键词：文档管理、项目管理、软件能力成熟度、现状调查 d o c u m e n tm a n a g e m e n ti ni tp r o je c t a b s t r a c t w i t ht h er a p i dd e v e l o p m e n to fi ti n d u s t r yi nc h i n a ，m a n yp r o b l e m so f m a n ya s p e c t si np r o j e c tm a n a g e m e n th a v e b e e no b s e r v e d d o c u m e n t i n g m a n a g e m e n ti soneo ft h ew o r s t t h i sd i s s e r t a t i o ns t a r t sw i t ht h es u r v e yo f p r e s e n ts i t u a t i o no fp r o j e c td o c u m e n t i n gm a n a g e m e n ti nc h i n ai ti n d u s t r ya n d a n a l y s e si t ss t a t u s b yv i r t u eo ft h et h e o r i e so fc m mf r a m e ，c o m b i n i n gw i t h c h i n ae x i s t i n gs t a t eo fa f f a i r s ，t h ed i s s e r t a t i o ns u g g e s t sm a n a g e m e n tf r a m e w o r k ， p r o c e s sa n dp r a c t i c a lm e a n so fi m p l e m e n t i n gp r o c e s s k e y w o r d s ：d o c u m e n t i n gm a n a g e m e n t ，p r o j e c tm a n a g e m e n t ， s o f t w a r e c a p a b i l i t y m a t u r i t ym o d e l ，s u r v e yo f p r e s e n ts i t u a t i o n 独创性( 或创新性) 声明 本人声明所呈交的论文是本人在导师指导下进行的研究工作及取得的 研究成果。尽我所知，除了文中特别加以标注和致谢中所罗列的内容以外， 论文中不包含其他人已经发表或撰写过的研究成果，也不包含为获得北京邮 电大学或其他教育机构的学位或证书而使用过的材料。与我一同工作的同志 对本研究所做的任何贡献均已在论文中作了明确的说明并表示了谢意。 申请学位论文与资料若有不实之处， 本人签名：喜；糸卜 本人承担一切相关责任。 日期：! ! ! ：! - ! ! 关于论文使用授权的说明 学位论文作者完全了解北京邮电大学有关保留和使用学位论文的规定，即： 研究生在校攻读学位期间论文工作的知识产权单位属北京邮电大学。学校有权保 留并向国家有关部门或机构送交论文的复印件和磁盘，允许学位论文被查阅和借 阅；学校可以公布学位论文的全部或部分内容，可以允许采用影印、缩印或其它 复制手段保存、汇编学位论文。( 保密的学位论文在解密后遵守此规定) 保密论文注释：本学位论文属于保密在一年解密后适用本授权书。非保 密论文注释：本学位论文不属于保密范围，适用本授权书。 本人签名：生盏煎 日期：竺! ! ：! ：! 导师签名日期： i t 项目中的文档管理第2 页共3 5 页 第一章引言 1 1 论文选题的背景 什么是文档? 文档是一种信息媒体和其上所记录的信息。在软件生产的i t 项目中，由程序构成的软件产品本身就是文档。在本文中讨论的文档是除了程序 文档以外的所有项目文档。 在项目之中，文档是沟通的主要工具之一：与项目的各方沟通项目目标，与 实施项目的成员沟通实旌目标的方法，与客户沟通项目的使用和维护方法等等： 在项目之外，对于企业来说，文档同时还是知识管理的重要内容。为了使文档发 挥应有的作用，对文档的有效管理显得尤为重要。 i t 项目管理中的文档管理是一个老生常谈话题了。文档管理的重要性与必要 性是不言而喻的。为了使软件文档能起到多种桥梁作用，使它有助于程序员编制 程序，有助于管理人员监督和管理软件开发，有助于用户了解软件的工作和应做 的操作，有助于维护人员进行有效的修改和扩充，文档的编制必须保证一定的 质量。质量差的软件文档不仅使读者难于理解，给使用者造成许多不便，而且会 削弱对软件的管理( 管理人员难以确认和评价开发工作的进展) ，增高软件的成本 ( 一些工作可能被迫返工) ，甚至造成更加有害的后果( 如误操作等) 。 具体来说，文档管理的重要性主要体现在： 1 ，文档管理的质量好坏往往是项目成功与否的重要原因之一。 在整个i t 项目的生存期中，各种文档作为半成品或是最终成品，会不断地 生成、修改或补充，使得文档的管理成为了一件庞大而繁琐的工作。同时，文档 管理质量的好坏不仅反映了项目管理水平的高低，而且直接关系到项目的成功与 失败。例如，对于需求文档的管理：由于需求的变更而没有及时更新需求文档， 或者没有及时更新相应的设计文档，造成最终产品与需求的不符，或者到项目后 期的返工，往往会造成项目的失败。 2 ，文档管理的质量对项目管理水平的提高有着很大的促进作用。 所有重要的项目的内容都需要落实到文档中，所以文档管理的规范和高质量 同时也是促进项目管理水平提高的个手段之一。 北京邮电大学硕上学位论文 1 t 项目中的文档管理第3 页共3 5 页 3 ，高质量的文档管理是项目最终得到高质量产品的保证。 文档在项目中的主要作用就是沟通，高质量的文档管理意味着高质量的文档 还有高效、准确地沟通，给制造高质量的产品提供了很好的保证。 4 ，文档管理质量的高低同时也是反映项目管理质量的高低。 项目文档的管理是项目管理的一个方面，所以文档管理质量的高低也就从一 个侧面反映了项目管理水平的高低。 5 ，高质量的文档管理还能提高企业的生产率。 项目的文档是企业知识管理的只要内容之一，企业在实施项目时，如果遇到 以前项目中曾经遇到的问题，那么项目组就能很快地在过去的项目文档中找到或 者借鉴到解决问题的方法，这样就能大大缩短项目开发的时间，提高了项目成功 的机率。 高质量文档管理在项目管理中的重要性和迫切性越来越突出。可是很多人向 我抱怨，他们所在的企业文档管理工作做得非常糟糕，从而大大增加的工作量， 使得很多简单的工作复杂化，造成效率低下。那么在文档管理中容易出现什么问 题，又有什么好的方法去解决这些问题? 是很值得我思考和研究的问题。 1 2 论文研究的目的和内容 随着i t 行业在中国的迅猛发展，成千上万的i t 企业如雨后春笋般孕育而生。 但是很多i t 企业在发展的过程中，遇到了不少问题，其中，如何管理项目，使 得项目按时、高质量并以最低成本完成，是中国i t 企业关注的。项目文档管理 是项目管理中较为突出的问题之一。本文通过对文档管理理论的研究，并结合中 国i t 企业的现状，试图探讨适合中国i t 企业现状的文档管理流程和方法。 1 3 研究的主要方法和论文结构 1 研究的方法 本文以i t 项目的文档管理为研究内容，通过问卷调查的方法，随机调查中国 的十几家i t 企业中的员工，他们在项目中担当着不同的角色。从问卷调查中可 以了解到中国i t 企业中一些项目中文档管理的典型问题，针对这个问题，结合 北京邮电大学硕十学位论文 i t 项目中的文档管理第4 页共3 5 页 软件能力成熟度( c m m ) 理论，提出一些适合企业实际情况的文档管理的解决 方法。 2 论文结构 本文共分为五章对i t 项目中的文档管理进行理论和实践的分析。 第一章，主要介绍论文的背景以及研究的目的、方法和论文的结构。 第二章，主要阐述问卷调查的情况，以及从问卷调查中发现的i t 项目中文档 管理的典型问题，以及从调查中得到的我国i t 项目中文档管理的现状。 第三章，主要描述了软件成熟度理论框架，以及在该框架下，文档管理的标 准。 第四章，主要根据c m m 理论模型，研究和分析了i t 项目中文档管理的基本 框架和管理流程。 第五章，在第四章论述i t 项目中文档管理的基本管理流程的基础上，以案例 分析的形式，介绍i t 企业如何结合自己的实际情况，制定适合自己的文档管理 流程和方法。 第二章it 项目中文档管理的现状及分析 在我工作过的i t 企业，我感觉到这些企业在对文档的管理方面，做得远远 不够，很多时候我感觉如果文档管理工作做得好的话，工作起来会轻松很多。于 是，我想对我国的i t 项舀中文档管理的现状作了一些调查。 2 。1 我国i t 企业中的文档管理现状 为了了解我国i t 企业，尤其是中小企业的文档管理水平我调查了十四家 i t 企业。在这些公司中，规模在1 0 0 人以上的中型企业3 家，规模在1 0 0 人以 下的企业有1 1 家；其中6 家外资企业，8 家内资企业。 i 规模 性质 1 0 0 人 ，测试文档编写不规范，或者测试文档管理维护不当等严重问题。 由于测试文档是保证软件质量的重要文档，因此测试文档在项目文档的 地位举足轻重，但是很多企业对测试工作以及测试文档的编写非常不重视。 4 ，不能针对项目的具体情况编写文档。 有的企业盲目的跟随软件工程的一些理论，生搬硬套文档模版，编写了 很多项目不需要的文档，造成了人力物力和时间的巨大浪费。 有的企业自己定义一套极其简单的文档模版以及编写方法，导致文档的 数量太少，文档不能完全表达所有需要沟通的内容，很多沟通工作需要依靠 费时费力而且可靠性差的面对面的口头沟通。 5 ，文档编写的方法不正确。 由于没有使用正确的文档编写方法，使得使用文档的人看不懂文档，导 致文档不能发挥正确作用。 6 ，没有文档维护的规则和流程。 项目的文档也会随着项目的发展而发展。会从具有很多的不确定性到相 对确定，从比较概括抽象到比较具体，因此，项目文档并非一次成型的，需 要在项目的生命周期中不断的更新和修改。如果项目发生的变化而项目文档 ( 尤其是项目中的关键文档) 却没有随之更新和修改，就好比刻舟求剑一样， 原来的基准已经毫无意义了。 7 ，文档维护和控制的方法不正确。 在项目中的文档是有主线的，各主要文档之间是有关联关系的。如果不能 采取正确的方法来维护和控制，众多的文档维护工作将得不到有效的进行。 北京邮电大学硕士学位论文 i t 项目中的文档管理第9 页共3 5 页 8 ，不能在人力和时间上提供对文档管理工作的支持。 很多企业的领导认识不到文档管理的重要性，不舍得把资源花费到文档 管理上，当然得不到高质量的项目文档。 从这些问题中，不难看出，企业在编写、维护等各个环节中都存在着严重问 题，i t 项目失败率很高这种现象并非偶然。 2 3 原因剖析 在实际工作中，文档在编带4 和使用中存在着许多问题，有待于解决。从上面 的调查可以看出，造成软件文档质量不高原因主要是： 1 ，从认识方面，很多人不重视或者根本意识不到文档管理的重要性 这种不重视的观念在企业领导、开发人员和客户中非常普遍： 从企业领导层来说，编写文档的工作常常不能直接产生效益，所以 他们把注意力放在能够直接产生效益的代码编写工作中。 软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。和程 序工作相比，许多人对编制文档不感兴趣。于是在程序工作完成以 后，不得不应付一下，把要求提供的文档赶写出来。这样的做法不 可能得到高质量的文档。 书面沟通与非书面的沟通( 如：语言，表情，肢体语言等) 从用户方面看，他们又常常抱怨：文档售价太高、文档不够完整、 文档编写得不好、文档已经陈旧或是文档太多，难于使用等等。 2 ，在实践经验方面，很多企业缺乏实践经验，缺乏评价文档质量的标准。 国外的昨天就是中国的今天。国外i t 企业的项目管理也是从混乱的中走到 相对规范的今天的。i t 业在中国仅仅发展了短短几年，软件工程在中国还属于 新鲜事物，很多企业非常缺乏用时间积累起来的实践经验，因此缺乏评价文档质 量的标准。 3 ，在管理流程方面，没有文档管理流程或者管理流程不完善。 很多i t 项目中文档，要么没有文档管理流程，要么管理的流程非常不完善。 何时编写，何时维护，又由谁来编写和维护，按照什么规则来编写和维护? 这些 在文档管理流程方面的问题时时困惑着项目的管理者。这主要还是不重视的思想 北京邮电大学硕士学位论文 i t 项目中的文档管理第1 0 页共3 5 页 和缺乏经验所导致的。 4 ，在实施文档管理的过程方面，没有正确的方法和适当的工具作为文档管 理的强有力的保证。 5 ，在人力资源方面，没有足够的人员保证文档管理工作。 从上面的调查数据也能看得出来，很多企业没有专门的人力来编写和维 护文档，想得到高质量的文档，当然是不可能的。一方面，是公司领导不重 视造成的；另一方面，如果雇佣专门的文档编写和维护人员不懂技术，想让 他( 她) 做好相对专业的项目文档工作也是不能的。 6 ，文档编写和管理人员的待逼方面，没有足够的预算开支来保证文档管理 工作。 目前，在我国由于文档管理工作并不受重视，企业不愿意花很多人力资源成 本来保证文档管理工作的高质量。其实企业往往只看到了雇员工的显性成本，却 往往忽视了由于文档管理的低下造成效率低下的隐性成本。真是丢了西瓜捡芝麻 啊。 第三章浅谈软件能力成熟度( e m m ) 理论 文档管理是在生产软件产品过程中产生的，因此是软件工程重要的部分 同时也是软件能力成熟度( c m m ) 模型的重点强调的一个内容。 软件能力成熟度( c m m ) 模型是基于多年产品质量研究成果所建立的，它为 软件企业的过程能力提供了一个阶梯式的进化框架，并指明了一个成熟的软件组 织在软件开发方面需要管理的那些主要工作这些工作之间的关系、以及以怎样 的先后次序，一步步的做好这些工作使软件组织走向成熟。 3 1c m m 的基本结构和内容 c m m 是一个框架，它包括五个等级，共计1 8 个核心过程域，5 2 个目标， 3 1 6 个核心实践。c m m 描述了五个级别的软件过程成熟度( 初始级、可重复级、 己定义级、已管理级、优化级) ，成熟度反映了软件过程能力( s o f t w a r ep r o c e s s 北京邮电大学硕士学位论文 i t 项目中的文档管理第1 1 页共3 5 页 c a p a b i l i t y ) 的大小，任何一个软件机构的软件过程必定属于其中某个级别。除了 第一级以外，每级成熟度又由若干关键过程域( k e yp r o c e s s a r e a ) 构成。五个成熟 度及其关键过程领域如下图所示： 有纪 过 图1c m m 五个成熟度以及关键域 第一级：初始级( t h ei n i t i a ll e v e l ) 初始级的软件机构缺乏对软件过程的有效管理，其软件项目的成功来源于个 人英雄主义而非机构行为，因此它不是可重复的。 第二级：可重复级( t h e r e p e a t a b l e l e v e l ) 第二级软件机构的主要特点是：项目计划和跟踪的稳定性，项目过程的可控 性和以往成功的可重复性。更具体的说： 机构建立了管理软件项目的策略和实现这些策略的过程； 北京邮电大学硕士学位论文 i t 项目中的文档管理第1 2 页拱3 5 页 新项目的计划和管理基于类似项目的经验； 过程能力的增强基于以各个项目为基础的有纪律的基本过程管理； 不同的项目可有不同的过程，而对机构的要求是具有指导项目建立适当 管理过程的策略； 每个项目都确定了基本的软件管理控制，包括： 基于前面项目的经验和新项目特点，做出现实的项目承诺( 如预算、 交付期、软件质量等) ； 软件项目管理者要跟踪开支、日程、软件功能； 满足承诺的过程中的出现的问题要及时发现，妥善解决： 定义了软件项目标准，且机构确保其被遵守。 第三级：已定义级( 1 1 1 ed e f i n e dl e v e l ) 第三级的主要特征在于软件过程已被提升成标准化过程，从而更加具有稳定 性、可重复性和可控性。处于第三级的企业具有如下一些特征： 机构采用标准的软件过程，软件工程和管理活动被集成为一个有机的整 体。标准化的目的是使之可使管理者和技术人员有效工作； 有一组人员专门负责机构的软件过程，并且在机构中有培训计划来确保 员工和经理有知识和技能完成所赋予的角色； 标准的软件过程结合项目的特点即形成定义的软件过程，它包括一组集 成的定义良好的软件工程和管理过程； 一个定义良好的过程包括就绪准则、输入、完成工作过程、验证机制、 输出和完成准则； 在已建立的产品线上成本、时间进度、功能均可控制，软件质量被加以 跟踪； 过程能力体现在在机构范围内对一个定义的软件过程活动、角色和责任 的共同理解。 第四级：已管理级( t h em a n a g e dl e v e l ) 第四级的软件枫构中软件过程和软件产品都有定量的目标，并被定量地管 理，因而其软件过程能力是可预测的，其生产的软件产品是高质量的。具体地说， 第四季的机构具有如下特征： 软件过程和产品有定量质量目标：一 重要的软件过程活动均配有生产率和质量度量； 数据库被用来收集和分析定义软件过程的数据； 北京邮电大学硕士学位论文 i t 项目中的文档管理第1 3 页共3 5 页 项目的软件过程和质量的评价有定量的基础； 项目的产品和过程控制具有可预测性。 缩小过程效能落在可接受的定量界限内的偏差 可区分过程效能的有效偏差和随机偏差； 面向新领域的风险是可知并被仔细管理。 第五级：优化级( t h eo p t i m i z i n gl e v e l ) 概括来说，第五级的主要特点是技术和过程改进被作为常规的业务活动加以 计划和管理。处于第五级的企业具有如下一些特征： 机构集中于连续的过程改进； 具有标识弱点和增强过程的手段； 采用过程数据分析使用新技术的代价效益并提出改进； 项目队伍能够分析出错原因并防止其再次出现； 防止浪费是第五级的重点； 改进的途径在于已有过程的增量改进和使用新技术和新方法的革新。 3 2c m m 各级的关键过程域k p a 除第一级外，c m m 的每一级是按完全相同的结构成的。每一级包含了实现 这一级目标的若干关键过程域( ) a ) ，每个k p a 进一步包含若干关键实施活动 ( k p ) ，无论哪个k p a ，它们的实施活动都统一按五个公共属性进行组织，即每一 个k p a 都包含五类k p 。这些关键活动分别为完成该组目标所需的承诺 ( c o m m i t m e n tt op e r f o r m ) 、前提条件( a b i l i t yt op e r f o r m ) 、执行活动( a c t i v i t i e s p e r f o r m e d ) 、度量分析( m e 删e m e ma n da n a l y s i s ) 以及实施验证( v e i l f y i n g i m p l e m e n t a t i o n ) 。上述五方面被称为五个共同特征。c m m 等级内部结构如下所 示。以下分别进行说明。 北京邮电大学硕士学位论文 i t 项目中的文档管理第1 4 页共3 5 页 图2c m m 内部特征 1 目标：每一个k p a 都确定了一组目标，若这组目标在每一个项目都能实现， 则说明企业满足了该k p a 的要求。若满足了一个级别的所有k p a 要求，则 表明达到了这个级别所要求的能力。 2 承诺：实施保证是企业为了建立和实麓相应k p a 所必须采取的活动，这些 活动主要包括制定企业范围的政策和高层管理的责任。 3 前提条件也称为实施能力，是企业实施k p a 的前提条件。企业必须采取措 麓，在满足了这些条件后，才有可能执行k p a 的执行活动。实施能力一般 包括资源保证、人员培训等内容。 4 执行活动：执行过程描述了执行k p a 所需求的必要角色和步骤。在五个公 共属性中，执行活动是唯一项目执行相关的属性，其余四个属性则涉及企业 c m m 能力基础设施的建立。执行活动一般包括计划、执行的任务、任务执 行的跟踪等。 5 度量分析：度量分析描述了过程的度量和度量分析要求。典型的度量和度量 分析的要求是确定执行活动的状态和执行活动的有效性。 6 实施验证：实施验证是验证执行活动是否与建立的过程一致。实施验证涉及 到管理的评审和审计以及质量保证活动。 第二级的关键过程领域( 砭p a ) 包括： 需求管理( r e q u i r e m e n t sm a n a g e m e n t ) ：客户的需求是软件项目的基础t 软 件需求管理的目的是在客户和软件项目之间达成对客户需求的一致理解。 北京邮电大学硕士学位论文 i t 项目中的文档管理第1 5 贞共3 5 页 软件项目计划( s o f t w a r e p r o j e c t p l a n n i n g ) ：为软件工程和项目管理建立一个 合理的计划。 软件项目的跟踪和监控( s o f t w a r ep r o j e c tt a c k i n ga n do v e r s i g h t ) ：使管理者 对实际的软件项目进展过程有足够的了解，以在项目效能偏离计划太多是采 取有效措施。 软件子合同管理( s o f t w a r es u b c o n t r a c tm a n a g e m e n t ) ：选择合格的分包商， 并有效管理之。 软件质量保证( s o f t w a r e q u a l i t y a s s u r a n c e ) ：对软件项目过程及其间生产的 各个产品进行监管以保证最终软件质量。 软件配置管理( s o f t w a r ec o n f i g u r a t i o nm a n a g e m e n t ) ：在整个软件生命周期 里建立并维护软件项目的工作产品的完整性。 第三级主要处理以下的k p a ： 组织过程关注( o r g a n i z a t i o np r o c e s sf o c u s ) ：确立机构对于改进机构的软件 过程能力的软件过程活动的责任。 组织过程定义( o r g a n i z a t i o np r o c e s sd e f i n i t i o n ) ：开发和维护一组有用的软 件过程和提供一个用于定义定量过程管理的有意义的数据的基础。 培训活动( t r a i n i n gp r o g r a m ) ：开发个体的技能和知识以使他们能够更加有 效的完成他们的角色； 集成软件管理( i n t e g r a t e ds o f t w a r em a n a g e m e n t ) ：基于业务环境和项目的技 术需要，从机构的标准软件过程和相关的过程a s s e t s 经过剪裁，将软件工程 和管理活动集成为一个有机的定义的软件过程； 软件产品工程( s o f t w a r ep r o d u c te n g i n e e r i n g ) ：一致地完成定义良好的工程 过程。它描述了项目的技术活动，如需求分析，设计，编码和测试； 组织间协调( i n t e r g r o u pc o o r d i n a t i o n ) ：确立软件工程组主动介入其它工程组 以便项目能更好满足客户要求的手段； 同行评审( p e e r r e v i e w s ) ：早而且有效的排除软件工作产品中的缺陷。它可 通过i n s p e c t i o n ，s t r u c t u r e dw a l k t h r o u g h 等手段进行。 概括来说，第三级企业的重点是工程过程和组织的支持( e n g i n e e r i n g p r o c e s s e sa n do r g a n i z a t i o n a ls u p p o r t ) 。 第四级的关键过程领域包括： 定量过程管理( q u a n t i t a t i v ep r o c e s sm a n a g e m e n t ) ：定量地控制软件项目的过 程效能； 北京邮电大学硕士学位论文 i t 项目中的文档管理第1 6 页共3 5 页 软件质量管理( s o f t w a r e q u a l i t y m a n a g e m e n t ) ：定量了解项目软件产品的质 量，并达到既定的质量目标。 第五级的关键过程域( a ) 包括： 缺陷预防( d e f e c tp r e v e n t i o n ) ：识别出错原因，防止错误再现( 通过改变定义 的软件过程) ； 技术变更管理( t e c h n o l o g yc h a n g em a n a g e m e n t ) ：识别有益的新技术f 工具、 方法和过程) ，并按有序的方式将其转移至机构之中。其重点在于在变化的世 界中有效的完成革新； 过程变更管理( p r o c e s sc h a n g em a n a g e m e n t ) ：连续改进机构所采用的软件过 程，以改进软件质量，提高生产率和减少产品开发时间。 概括来说，第五级企业的重点是连续的过程改进。 从上面的描述可以看出，c m m 给出了软件成熟与不成熟的标志： 不成熟的标志主要表现是：没有明确的过程体系可以依据，无法对生产进行 预测；不严格执行生产过程；质量无法保证；无健全的过程控制及质量控制体系； 项目开发没有准则可遵循；开发结果一举项目小组及个人的带有主观因素的能力 发挥。而成熟的标志表现是：项目开发时依据企业早已明确的过程准则来实施； 开发结果较少依赖个人能力可自然因素；项目与过程控制并可对整个生产做出预 测；产品质量得到有效监控( 借助客观定量化的数据) ；过去的开发项目中所获 经验得以积累并可系统地用于先行和未来的项目之中。 纵观整个c m m ，软件企业提高自身成熟度的历程是一个从无序到有序，从 特殊到一般，从定性到定量，最后不断自我完善的过程。软件企业如果严格按照 c m m 框架不断改善自身的管理，就能生产出高质量的软件产品。 3 3 成熟等级所指示的过程能力 一个组织的软件过程成熟度能帮助预测一个项目达到其目标的能力。等级1 组织中的不同项目在达到成本、进度、功能和质量等指标的能力上差别很大。正 如下图的例子所示，随着组织软件过程成熟，在满足预定目标方面能观察到三个 改进之处。 北京邮电大学硕士学位论文 r r 项目中的文档管理第1 7 页共3 5 页 概目标 耋 概 盎 概 家 概 童 概 靡 、 i j 墼引 等级5 的组织中性能持续不 断改进 基于对过程和产品的定量了 解，等级4 的组织中性能继 续改进 由于有妥善定义上的过程， 等级3 的组织中性能改进 等级2 组织的计划由于基于 过去的性能而比较现实可行 等级1 组织一般达不到进度 和成本目标 图3 成熟度等级所指示的过程能力 首先，随着成熟度增长，所有项目的预定目标结果与实际结果间的差异减小。 例如，如果有十个相同规模的项目预定在5 月1 日交付，那么随着组织的成熟， 它们交付的平均曰期会越来越靠近5 月1 日。等级1 组织常常远迟后于其进度 表规定的交付日期，而等级5 的组织应该能相当精确地满足预定日期要求。这是 因为等级5 上组织采用仔细构造的、在已知参数范围内运行的软件过程，而且 确定预定日期是基于他们所具有的有关其过程的大量数据，以及运用数据时的性 能。( 在图中，用预定日期线右边监线下的面积大小表示这一点。) 其次，随着成熟度增长，实际结果相对预定目标结果的偏差范围减小。例如， 等级1 组织中，对具有类似规模项目的交付日期是不可预测的，其变化很大。而 北京邮电大学硕士学位论文 i t 项目中的文档管理第1 8 页共3 5 页 等级5 组织中的类似项目的交付日期在小得多的范围内变化。在最高成熟度等 级上变化范围很小的原因是所有的项目实际上均在接近组织的有关成本、进度、 功篚和质量等过程能力的受控参数的范围内运行。( 图中，以集中于预定居标线 附近的面积大小说明这点。) 第三，随着组织成熟度的增加，预定目标结果得到改善。这就是说，随着软 件组织的成熟，成本降低，开发时间缩短、生产率和质量提高。在等级1 上的 组织，其开发时间可能十分长，因为必须完成大量的用以纠正错误的返工。相反， 等级5 组织采用不断改进过程和缺陷预防技术增加过程有效性和消除费钱的返 工，使得开发时间得以缩短。( 图中，这点反映在预定目标线在指向原点方向上 的水平移动。) 图3 中所表示的在预测项目结果方面的改进基于以下假定，即随着噪声( 通 常以返工形式出现) 从软件过程中消除，软件项目结果更加可以预测。但是，无 先例的系统会使情况复杂化，因为新的技术和应用问题增加可变性，从而降低过 程能力。即使在无先例系统的情况下，与比较不成熟的组织相比，较成熟的组织 管理和工程实践的特征能在开发周期的较早阶段帮助识别和阐述问题。由于较早 识别出缺陷，能消除后面阶段的返工，从而提高项目的稳定性和性能。风险管理 是成熟过程中项目管理的必不可少部分。在某些情况下，一个成熟过程意味着在 软件生命周期的早期识别出“失败”项目，使得在徒劳无功的事情上的投资最小。 第四章lt 项目中文档管理流程的框架 4 ，1c m m 二级对于文档管理的要求 c m m 框架强调，对于每一个重要的过程应形成文件，包括指导书和说明。 在c m m 的理论框架中，项目的文档管理被归在了c m m 二级关键过程域中的配 置管理。配置管理是对某个配置项的功能和物理特征性进行识别和编档；对这些 特征的变动进行控制；对变动和实施进行记录、汇报；验证需求计划的实现。 c m m 把文档的管理归为在配制管理这个关键过程域中，并且是在第二级( 相对 比较低的级别) 来强调，说明了在c m m 中，对于文档的管理是一个基本的要求。 北京邮电大学硕士学位论文 i t 项目中的文档管理第1 9 页共3 5 页 4 ，2 高质量文档的主要特征 高质量的文档应当体现在以下一些方面： 针对性；文档编制以前应分清读者对象，按不同的类型、不同层次的读者， 决定怎样适应他们的需要。例如，管理文档主要面向管理人员的，用户文档主 要是面向用户的，这两类文档不应像开发文档( 面向软件开发人员) 那样过多地使 用软件的专业术语。 精确性：文档的行文应当十分确切，不能出现多义性的描述。同一课题若 干文档内容应该协调一致，应是没有矛盾的。 清晰性：文档编写应力求简明，如有可能，配以适当的图表，以增强其清 晰性。 完整性：任何一个文档都应当是完整的、独立的，它应自成体系。例如， 前言部分应作一般性介绍，正文给出中心内容，必要时还有附录，列出参考资料 等。同一课题的几个文档之间可能有些部分相同，这些重复是必要的。例如， 同一项目的用户手册和操作手册中关于本项舀功能、性能、实现环境等方面的描 述是没有差别的。特别要避免在文档中出现转引其它文档内容的情况。比如，一 些段落并未具体描述，而用“见文档节”的方式，这将给读者带来许多 不便。 灵活性：各个不同的软件项目，其规模和复杂程度有着许多实际差别，不 能一律看待。对于较小的或比较简单的项目，可做适当调整或合并。比如，可将 用户手册和操作手册合并成用户操作手册：软件需求说明书可包括对数据的要 求，从而去掉数据要求说明书；概要设计说明书与详细设计说明书合并成软件设 计说明书等。 可追溯性；由于各开发阶段编制的文档与各阶段完成的工作有着紧密的关 系，前后两个阶段生成的文档，随着开发工作的逐步扩展，具有一定的继承关 系。在一个项目各开发阶段之间提供的文档必定存在着可追溯的关系。例如， 某一项软件需求，必定在设计说明书，测试计划以至用户手册中有所体现。必要 时应能做到跟踪追查。 4 3 规范的文档管理流程和方法 文档管理与别的事物一样，也有规律可循。例如：根据c m m 定义的成熟度 的不同要求；精简并行过程( s p p ) 为第三级别制定了6 0 余文档模版。根据文 北京邮电大学硕士学位论文 i t 项目中的文档管理第2 0 页共3 5 页 档在项目中的作用，文档可以分为以下三种类型： 第一类是产品文档。这类文档规定关于软件产品的使用、维护、增强、 转换和传输的信息，为用户了解软件的使用、操作和维护而提供的详细 资料，主要包括：用户手册，操作手册，维护手册，软件需求( 规格) 说明书等。 第二类是开发文档。这类文档主要是为了项目内部成员沟通项目目标、 项目目标实施的方法，主要包括：软件需求( 规格) 说明书，可行性分 析报告，概要设计说明书，详细设计说明书，数据要求说明书，辅助设 计设计说明书的流程图，编码说明书等。 第三类是管理文档。除了上两类文档之外的其他文档。目的是为了让项 目管理人员通过这些文档了解项目安排、进度、资源使用和成果等情况。 主要包括：项目总计划，项目计划的时间表，项目开发计划，项目测试 计划，测试案例，测试报告，定期的开发和测试报告，总结报告，各类 变更报告，会议备忘录等。 规范的文档管理流程主要有几个方面：1 ，文档模版的制作；2 ，文档管理和 控制流程的制定；3 ，文档的编写；4 ，文档管理规则和流程的实施；5 ，文档归 档等。如何编写和管理文档是有一套科学方法的。 1 ，制作文档模版 虽然不同的文档内容不相同，不过各文档包含的内容还是有一定的共同性的。 一般来说，每个项目文档的结构大致包含以下几个部分： i i 项目标志：用以表示项目文档的任何标准； 文档名称：标示主题，如：需求说明书、设计概要说明书、详细设计说 明书、测试用例、测试报告等； 文档编号：文档的唯一标识。有的公司如果使用软件来管理文档，往往 在文档的编号中反映文档的版本； 文档编写的历史情况：主要内容包括：编写者或修改者的姓名，编写或 修改的日期，编写或修改的内容等； 审阅或批准情况：参与审阅或批准的人员，审阅或批准的时间，审阅或 批准的情况或结果； 文档的主体：文档的内容。 一般的，文件的编号和修改日期应该在文档的每一页都出现。 各文档模版根据其作用不同，编写的内容也大相径庭。下面简要介绍主要文 北京邮电大学硕士学位论文 i t 项目中的文档管理第2 l 页共3 5 页 档需要编写的内容： 可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会 因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实 施的方案，说明并论证所选定实旋方案的理由。 项目开发计划；为软件项目实施方案制定出具体计划，应该包括各部分 工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资 源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。 需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、 用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软 件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。这 是整个项目的基线文档，基本上其他所有的文档都根据这份文档编写。 因此，这个份极其重要的文档。其他所有文档都要与它的最新版本严 格的保持一致。 数据要求说明书；该说明书应给出数据逻辑描述和数据采集的各项要 求，为生成和维护系统数据文卷作好准备。 概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能 分配、模块划分、程序的总体结构、输入输出阻及接口设计、运行设计、 数据结构设计和出错处理设计等，为详细设计奠定基础。同时还要说明 设计标准和规范、编码标准和规范等内容。 详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻 辑流程等。 用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解 如何使用该软件。 操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特 别是操作方法的具体细节。 测试计划：为做好集成测试、系统测试和确认测试，需为如何组织测试 制定实施计划。计划应包括测试的内容、进度、条件、人员等。 测试说明书：、主要包括测试原理、基本目标、基本过程、成功的标准、 测试结果允许的偏差范围、范围矩阵等。 测试用例：该文档主要包括的内容有：测试目标( 即：测试点，要做什 么) 、假设( 包含设计该测试用例的前提条件等) 、参考、成功的标准、 测试者、编写测试用例者、测试时闻、测试步骤、测试结果等。 测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。 对测试结果加以分析，并提出测试的结论意见。 北京邮电大学硕士学位论文 i t 项目中的文档管理第2 2 页共3 5 页 开发进度定期报告：该报告系软件人员定期向管理部门提交的项目进展 情况报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇 到的问题和解决的办法以及下阶段的打算等。 项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照， 总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。 此外还需对开发工作做出评价，总结出经验和教训。 2 ，制定文档管理与控制规则 文档通常要经过编写、审查、修改甚至重新编写等过程。因此需要制定的文 档管理与控制规则。规则主要涉及以下几个方面： 需要编写什么文档? 什么文档是主文档? 文档由谁编写? 何时编写? 由谁审查和批准? 如果主文档发生变更，哪些文档必须变更? 如果主文档发生变更，由谁修改其它必须变更文档? 何时完成修改? 由谁统一管理和控制文档，尤其是当主要文档发生变更时? 在项目文档中，以需求文档、开发文档和测试文档、变更文档等管理文档最 为重要，它们的编写和维护工作在项目中的时间阶段如下图所示： 巫尽生盒周翅 盟回2 - 醚弱隧黼颡磁瘸瓣l | l l 毹艘疆戮鞲匿蕊麓镒燃翻l 艄需求文档的编写与维护 瞬懿豳圈豳嘲瞬豳豳豳豳疆圈圜圃豳豳豳翻圜圜圈豳霸圜豳圈豳瞳豳 开发文档的编写与维护 啊圈圈 测试文档的编写与维j 其他文档的编写与鲜 文档归档 图4 关键文档的编写和维护工作在项目生命周期中进行的阶段示意圈 3 ，根据文档模版编写相应文档 北京邮电大学硕士学位论文 i t 项目中的文档管理 第2 3 页共3 5 页 编写文档的最要的原则是规范且有针对性。根据文档不同的读者使用不同的 编写语言和编写的方法。例如：对于技术文档的编写，需要使用规范韵专业 术语，甚至规范的专业图表；而对于用户手册和操作说明书等此类用户文档， 则需要使用通俗易懂的语言来编写，如果能配上图片、动画或语音等手段， 则可以形象的向用户展示系统功能以及操作步骤等等。 4 ，根据规则实施文档管理与控制 即执行文档控制。规则制定起来很容易，执行起来却会遇到相当多的问题。 由于i t 行业具有变化快很多需求不成熟等特点，注定i t 项目的范围( 即： 项目需求) 在项目的初期和中期变化非常大，导致需求文档在项目的初期和 中期频繁变更。可是在这令阶段又是软件设计和编写代码的重要阶段，时间、 人员等资源都相对紧张。作为基准文档的需求文档的变更，会引发一系列重 要文档的变更。如何权衡资源的紧张问题和文档的变更问题，在项目管理中 是一大难题。一般有以下办法可以缓和一下矛盾； 使用工具来进行文档的控制，这样可以最大程度的减少设计人员和开发 人员的在文档编写和更新的工作量。 使用项目中在该阶段任务相对比较轻的项目成员来管理和控制文档。 识别哪些是最需要更新的文档，更新这些文档，其它重要程度相对低的 文档可以在以后项目进行到后期再加于补充和完善。识别的标准是，如 果该文档不更新将严重影响到以后的项目进程。 5 ，项目文档总结和归档 项目文档的总结和归档是一个重要的工作。这项一般是项目结束前的最后一 项工作。这项工作的目的在于总结在项目进行过程中项目文档编写和控制维 护的优缺点，有哪些不足之处，有哪些做得好的地方需要继续强化，在哪些 方面还可以进行改进使得以后会做得更好。同时把项目的文档整理成一套有 索引的文件存入公司的知识管理数据库中，更好的为以后的项目服务。这可 是公司的一一大笔无形资产啊，而且经过这个回顾和总结的过程，项目成员得 以消化和吸收项目中的得与失，对项目成员的提高有很大的帮助。因为这项 工作不能直接带来效益，因此很多公司在项目接近尾声时就迫不及待的给项 目成员分配新的工作。 北京邮电大学硕士学位论文 i t 项目中的文档管理第2 4 页共3 5 页 第五章如何改进文档管理 5 1 解决文档管理方面典型问题的方法 虽然在文档管理上存在着很多问题，但是，很多人也在寻找着解决问题的方法。 在这一节中，主要描述在一些在实践中经常运用的具体的解决方法。 1 ，文档编写的规划 在项目开始初期，需要对文档的编写进行详细的规划。怎样强调规划都不为 过，不进行规划就不知道目标是什么，怎么达到目标。规划工作包括： 需要编写什么文档? 一般来说，项目的核心文档是需求文档，设计文档 和测试文档。对于设计文档来说，主要包括概要设计文档和详细设计文 档，对于测试文档来说，主要包括单元测试文档，集成测试文档、系统 测试文档、移交测试文档等等。在规划阶段，可以根据项目的复杂程度 设计需要编写的文档。如果项目的复杂程度相对比较低，可以仅编写详 细设计文档，而不需要再编写测试文档了；对于测试文档来说，也可以 仅编写集成集成测试文档和系统文档即可。 文档需要编写什么内容? 与需求文档为例，如果需求相对简单的话，那 么编写一般的需求文档即可，如果需求相对复杂，那么则要考虑是否需 要编写其它辅助的需求文档，比如，软件模型图或者软件原型文档等， 以更加形象的方式来