项目文档管理

项目文档管理(Project Documents Management)

目录

  • 1 项目文档管理的概述
  • 2 文档管理在项目进程中的重要作用
  • 3 如何建立项目文档管理规定
  • 4 参考文献

项目文档管理的概述

  项目文档管理,是指在一个系统(软件)项目开发进程中将提交的文档进行收集管理的过程。通常,文档管理在项目开发中不是很受重视,当发现其重要性时,往往为时已晚。整个项目可能因此变得管理混乱,问题产生后无据可查。文档管理对于一个项目的顺利进行有着至关重要的作用,其关键性不容忽视。

  项目文档管理涉及范围广泛,其内容会根据项目的不同而有所变化。这里将重点讨论金融计算机软件开发项目中的文档管理。

  首先要了解文档管理的行业标准。目前ISO认证的企业通用管理规范为软件系统开发提供了通用的管理规定和行业标准,它涉及文档管理的整个生命周期。细分文档的生命周期,一般包括:创建、审批、发布、修改、分发、签收、追缴、归档、废止与恢复这样几个环节。那么当企业需要按照ISO建立标准的文档管理规范时,将从何入手昵?

  对此,首先要将文档分为普通纸质文档和电子文档两类来讨论。通常情况,在一个项目中都会确定专门或兼职的项目文档管理员。对于纸质文档,文档管理员只需要关心如何将其较好地分类归档并保存,而之前的各个环节则要由整个项目组共同把握。

  就目前业界项目的开发情况来看,电子文档使用较纸质文档更为方便、灵活、广泛。对于电子文档,我们大可不必头疼如何管理其整个生命周期。VSS(Visual Source Safe)作为一种电子文档管理工具给我们提供了完整的文档管理功能,它覆盖了文档管理全生命周期各环节的管理要求。VSS通过客户端/服务器(C/S)架构收集整个项目组成员的各类文档,通过管理员合理规划管理,将电子文档按目录保存并同时提供给整个项目组的不同成员使用。因此对于文档管理,重要的是如何规划并制定出一套适合于自身项目的文档管理规则。

文档管理在项目进程中的重要作用

  作为管理完善的项目文档,管理者完全可以依顺它的轨迹看清整个项目进展的脉络,同时通过对阶段性文档的把握使整个项目质量得到很好的掌控。制定一套完整有序的项目文档管理规定十分必要,其作用有以下6个方面。

  其一,它是项目管理者了解开发进度、存在的问题和预期目标的管理依据。第二,大多数软件开发项目会被划分成若干个任务,并由不同的组去完成。文档管理则是不同小组任务之间联系的重要凭证。第三,可提供完整的文档,保证了项目开发的质量。第四,项目文档是系统管理员、操作员、用户、管理者和其他相关人员了解系统如何工作的培训与参考资料;第五,项目文档将为系统维护人员提供维护支持;第六,项目文档作为重要的历史档案将成为新项目的开发资源。

  现在大多数金融、通信企业为了更好的服务客户、准确掌握自身数据,都在不遗余力地建立数据仓库系统。企业数据仓库(EDW)从筹建项目组到软件开发建设再到系统上线维护,基本涉及了软件项目建设的所有环节,对文档管理提出了比较全面的要求。以下就EDW建设为例做作进一步探讨。

  首先要借助VSS软件建立项目文档管理服务器以保存所有的项目文档。其次,项目保存的文档要涵盖项目管理、项目调研、项目开发、项目应用、系统管理、系统测试验收、项目培训、版本控制、数据质量管理、用户手册、系统上线等整个项目周期。然而从项目管理者的亲身体会来讲,这些文档的保存往往是混乱无序,无法快捷地获得所需信息。究其原因,项目组在系统开发过程中虽然重视了文档的保存,但却忽视了文档的管理。文档归档没有正式的管理要求,缺少文档提交的依据和规则。最后是建立文档管理规定。

  以EDW项目为例,未建立文档管理的情况如图1所示。由于没有统一的文档管理规定,项目小组只对自己负责的项目文档熟悉。此外,无论是项目小组成员还是项目经理都对自己需要的其他文档的保存地点、文档名称等信息缺乏了解,无法及时获取重要文档。因此,项目经理根本无法从项目文档把握项目进展情况。

  制定了文档管理规定后的情况如图2所示。由于项目文档管理员按照规定对文档进行管理,因此项目经理及小组成员都能快速得到自己所需的各类文档。同时,项目经理还可以很清晰地透过项目文档把握项目进展情况。

如何建立项目文档管理规定

  从各行业以及每个项目的个性出发,需要管理者结合实际情况制订出适合自身的文档管理规定。(软件文档管理指南》和《计算机软件产品开发文件编制指南 (以下统称《指南》)为我们提供了相关的指导。首先要明确关于软件项目文档的具体分类。《指南 中提出文档从重要性和质量要求方面可以分为非正式文档和正式文档;从项目周期角度可分为开发文档、产品文档、管理文档;更细致一点还可分为l4类文档文件,具体有:可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、概要设计说明书详细设计说明书数据库设计说明书用户手册、操作手册、模块开发卷宗、测试计划、测试分析报告、开发进度月报、项目开发总结报告。这样的分类细化了项目进度中各个阶段所需管理的文档。

  其次需要将项目文档进行归类整理。下面对EDW项目组文档情况与 软件文档管理指南 进行对比分析(见表1)。通过对比可以看出,没有规范管理的EDW项目组文档存在以下4方面的问题。

  问题1:项目组在开发初期针对业务部门和科技部门进行了需求及信息调研,可以覆盖部分软件需求数据需求说明书的内容,但却缺少业务部门对项目需求描述和变更的文档记录。这部分文档需建立相应目录予以保存。

  问题2:对于设计说明,在系统比较复杂的情况下,设计阶段应分解成概要设计和详细设计两个步骤。目前EDW项目组只对ETL模块提供了概要设计说明书,并没有单独的存放目录,而是同其他设计文档混乱地放在一起。对于比较复杂的应用开发项目,应将这两种设计说明文档分目录管理。

  问题3:在项目测试验收中,项目组没有要求将测试计划文档和测试结果报告进行规档,而只重视了测试过程中的问题文档,因此无法掌控测试进度与质量。

  问题4:EDW项目组的工作分为模型设计、ETL、集市应用3个工作小组,对应的文档管理需要围绕这3个主题进行。其中模型设计和ETL都是数据仓库项目实施的模块,而集市应用则包括了建立在数据仓库基础上的小项目开发。因此,文档管理也应该针对这3个部分不同的性质制定管理规则。

  通过表l中的对比分析,针对EDW文档管理存在的问题,EDW项目组最终依据通用规则建立了正式的项目文档管理规定。具体规定有以下5点。

  (1)将文档分为两大部分提交管理:项目常规文档和项目归档文档。常规文档的提交和使用根据项目组内部小组成员任务的不同进行权限划分;项目归档文档由项目管理主管(或项目文档管理员)将项目中的重要文档从常规文档中进行分类归档。

  (2)常规文档管理目录分为项目日常管理文档和项目流程管理文档。

  (3)日常管理文档包括项目报告、会议纪要、项目管理模板、重大问题跟踪、数据质量管理。项目报告又可分为个人周报、小组周报、项目周报、项目简报,项目简报。并都按照不同目录进行分类管理。

  (4)提交完整的项目开发、应用开发流程文档。一般包括:项目计划、业务需求说明书、数据需求说明书、模块、应用开发文档、系统测试文档、详细设计文档、系统测试文档、用户手册、上线文档、培训资料、系统运行维护等。

  (5)所有项目组成员均建立VSS软件环境下的对应用户,各自拥有对以上各类文档的读、写、增加、删除权限。由各项目小组长保证提交已保存文档的质量;由文档管理员或项目经理整体把握项目文档在各阶段的提交情况(见表2)。

  项目文档管理规范制定好之后,关键在于大家要“依规执行”,使杂乱无章的存放模式变得井井有条。

参考文献

阅读数:145