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

原创 2006年06月06日 09:28:00

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

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

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


2文档需要专人负责。

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


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

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


4 文档的份数。

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

今天就先写到这里了,希望大家看后补充 谢谢

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

文档管理混乱是上个项目最为致命和混乱的,我个人认为,如果一个项目小组进行开发一个系统的时候没有文档的开发个人认为是可怕的,而在系统的开发中没有对文档进行有效管理是恐怖的,我们要做的是一个产品,而不是自...
  • Chendy
  • Chendy
  • 2007年12月12日 10:47
  • 472

苏宁面试记录

1.自我介绍一下 2.做过的项目,代码量估计一下 3.为什么选C++,C++在你做过的项目中的体现,详细介绍一下 (教训:一定要有实践经验,将理论和项目结合自己的理解弄透) 4.循环队列 取指...
  • u012124634
  • u012124634
  • 2017年09月06日 19:22
  • 488

Android初学之惨痛教训

HelloAndroid调通,一直问题不断,耗时2天。写下来,希望对大家有所帮助。 问题描述如下, 1、找不到D:\workplaceEclipseAndroid\appcompat_v7\bin...
  • hgsunyong
  • hgsunyong
  • 2015年03月24日 16:25
  • 798

血的教训之 ---- 字符集

软件工程考完试了,打算把以前用VC6.0写过的一个700行的小程序重新整理下(VC6 默认的 多字符集),并增加些新的功能(类已经写好,用VS2010默认的Unicode),整在一起后发现问题多多呀!...
  • a576323437
  • a576323437
  • 2012年12月29日 15:34
  • 327

一次血的教训

在网站上面被一些各种低价的吸引,这个可能也是自己的原因,贪小便宜以为苹果5就卖2200元,于是就订购了一部,货到付款的,这外观真的做的是非常的像,于是直接付款,用后才知道是山寨机,而且里面的配置是非常...
  • zzz5323381
  • zzz5323381
  • 2013年08月17日 10:30
  • 322

血的教训!!!

这两天在做数据平台,昨天完善功能不知不觉给自己挖了很大一个坑… 事情是这样的:数据平台后台有定时任务,每天执行统计数据插入对应的表。因为表中新添了一个字段,以前定时任务跑的数据都需要清空重新录。怎么...
  • u013897685
  • u013897685
  • 2016年08月16日 13:51
  • 169

血的教训啊!!!

     这一年多的收集一些项目和学习心得,都因为一个系统崩溃,而又在重装系统的时候来了个误操作,结果把整个硬盘给格式化了,没有备份,偶的天啊,以后再也不会有这种情况发生了,必须小心,小心,再小心!!...
  • hk8846
  • hk8846
  • 2008年09月12日 02:12
  • 367

血的教训!!

今天由于之前的两个致命错误导致了恶果: 1,把正在开发的android项目代码放在home目录下,今天在装gtk库时把系统搞崩,结果此目录下的git项目全丢。血泪的教训。 2,没有看gtk的用途及...
  • dongshengzou95
  • dongshengzou95
  • 2013年04月27日 16:52
  • 357

rm血的教训

使用rm -rf 删除文件一定要慢呀,三思呀,尤其是删除文件夹。 本人准备删除一个以T开头的文件夹,却不慎t和shift没能同时按下,于是打出了t,习惯性的按下了tab,然后就是回车了,于是悲剧产生...
  • chn89
  • chn89
  • 2011年12月27日 16:44
  • 713

血的教训

罗列调试过程的血的教训,希望以后不要再犯! 1、反射的方法是不能操作UI滴!!!...
  • gaitiangai
  • gaitiangai
  • 2016年05月23日 11:33
  • 310
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:关于软件工程血的教训之文档管理
举报原因:
原因补充:

(最多只允许输入30个字)