关于软件工程血的教训之文档管理

发表于:2008-02-03来源:作者:点击数: 标签:软件工程教训文档管理
文档管理混乱是上个项目最为致命和混乱的,我个人认为,如果一个项目小组进行 开发 一个系统的时候没有文档的开发个人认为是可怕的,而在系统的开发中没有对文档进行有效管理是恐怖的,我们要做的是一个产品,而不是自娱自乐的一个试验品,作为产品,必须要标
 文档管理混乱是上个项目最为致命和混乱的,我个人认为,如果一个项目小组进行开发一个系统的时候没有文档的开发个人认为是可怕的,而在系统的开发中没有对文档进行有效管理是恐怖的,我们要做的是一个产品,而不是自娱自乐的一个试验品,作为产品,必须要标准,无论是客户给我们的标准还是开发小组给自己的标准,关于标准将在后面做详细讨论。而有标准就必要有相关的文档,关于文档的好处大家都清除,无论在软件开发部署以及维护的任何阶段它都扮演着很重要的角色,关于文档我觉得它不是形式一个开发小组的负责人对文档的态度就觉得乐这个系统的成败(说的夸张些)。

    除了认真做各个阶段的相关文档外,还要对文档进行有效管理,下面将说一下这几年来对文档管理的一些开发,仅仅是抛砖引玉,欢迎大家补充和牌砖。


   1 、文档必须需要版本。

    像软件一样,如果不对文档进行版本管理和控制,文档的修改将造成文档的混乱,尤其是比较大的项目,一定对文档的管理进行版本控制,不然每次文档修改,想找到什么时候做乐什么修改,为什么做这次的修改都搞不清楚,后面的程序员的工作就很难开展。


    2、文档需要专人负责。

    如果一个小组的人手足够多的话,希望能有一个人来专门负责对文档管理,如果开发小组的人手紧张需小组某一个人简直负责,不能每个人都随意的对所有的文档都拿来拿去。


    3、文档的修改要有严格的章程控制。

    文档一旦形成,不能随意修改,当然形成正式版本的文档之前一定要认真讨论确定文档,一旦文档确定后,不能随意修改,尤其是前期文档,如需求分析,需求分析一变后面的设计文档都要变,这样变来变去会影响到系统的整体进度与软件的质量。每次修改都要做好记录为什么要做这个修改,修改乐哪些部分 会影响到哪些文档一定要注明还要包括文档修改的发起人和批准人。


    4 、文档的份数。

    个人认为一个十人以内的开发小组每个版本的文档只需要一份,尤其是开发阶段流传在程序员手中的文档尽量只有一份,大家以互相传阅的方式进行查阅文档,并不是每个人一份文档会给项目的进度带来有利的影响,上一个项目中每次文档修改后,都给每个人打印一份近千页的文档,一是造成了巨大的浪费,二是由于没有对版本控制好,每个人手里的文档不止一份,开始的时候大家还比较清楚到最后,大家都快搞不清应该以哪一份文档为准了。

原文转自:http://www.ltesting.net