阅读内容

准确传递技术文档在项目管理中重要性

  [日期:(2013-3-28)]  

  在某个娱乐节目中曾经看到,主持人给出一块白板写上某个词,例如“跳舞”,台上的参与者一个接一个用形体表达试图传递给下一个参与者,每次都了最后一个,总会出现风马牛不相及的结果,这就是一个沟通过程中信息失真的问题,在软件开发中,来自客户的需求信息失真的情况也是有发生,结果严重浪费了有限的资源,甚至造成严重的工作失误,给公司造成不可挽回的损失。

  为了提高沟通的准确度,我们希望记录文档,但是书写详细的文档向来遭到普遍开发人员的抵触,一是书写文档乏味枯燥,二是由于一的原因,没有认真书写的文档,可读性差,利用价值大打折扣,三是没有同步更新以前书写的文档,利用价值更低,更加让人迷惑,甚至有误导的风险,这点属于普遍性问题。

  为此,我们引入XP编程中简略文档(Minimal Documentation,指开发过程中不必书写很详细的文档,只要书写较少关键性的文档就可)。例如,来自于客户的需求,一般只需要把需求场景,客户实际业务操作,同类软件的实现等信息描述清楚即可,而BUG则描述怎么操作产生,便于开发人员快速诊断,而开发人员完成事务的时候,需要填写修改说明,描述修改的位置、涉及的变更、需要编译哪些系统等。所有的此类信息可以邮件附件发送、或者附件在测试管理平台URTracker,或者配置管理工具SAW中。

  “好记性不如烂笔头”,有了文档,哪怕再简陋,也比后来事后纠缠于理解错误是如何发生的要好。

 
分享到: