递增式文档能否解决文档编写困难症?

对很多实施GJB5000的组织来说,都存在文档编写困难症。

一方面,在软件开发规范起来之前,开发人员都是直接写代码,直接调试,没有编写文档的意识;另一方面,开始实施GJB5000之后,开发人员不得不编写代码,但总觉得编写文档要花费很多时间和精力,费效比不高。

开发人员对于编写文档总是不情不愿,这就是文档编写困难症。

有一种递增式完成文档编写的方法,可能有助于解决文档编写困难症。

递增式的文档编写方法原理并不复杂。

首先,准备一份包含所有项目要完成的文档的提纲,在项目开始时将此提纲放在每个团队成员的工作任务包里。然后,在项目过程中,当每一项与编写文档相关的关键任务完成时,都要求负责文档编写的团队成员提供与任务相关的几句、几段或几页文档,并将这些片段插入文档提纲内适当的位置。

这种“递增式文档”操作起来相对不那么“痛苦”,因为它将漫长的、略显枯燥的文档编写过程打散、拆分在整个开发过程中,当所有与文档相关的任务全部完成之时,文档也最终编写完成。

以软件开发计划为例。

把GJB438B对软件开发计划的编写要求作为其编写提纲。开发计划各项内容与相关任务的关系如下:

开发计划内容 对应的需完成的任务
1 范围 
2 引用文档
立项
3 策划背景 
4 软件开发活动的总体实施计划
任务书评审
5 详细的软件开发活动实施计划
6 进度表和活动网络图
7 项目组织和资源
项目估计
质量保证计划编制
配置管理计划编制

“递增式文档”的编写方法同时也会带来文档验证方法的改变。每一次文档更新,都应进行QA审查,必要时也需要进行简化的二人评审。当文档的全部内容都完成的时候,就可以开展正式的文档评审。

如果所有的文档都采用递增式的编写方法,那么还会带来不同文档递增部分开发顺序等的影响关系。

虽然递增式文档编写方法真的运用起来还要考虑这些内容,但它依然为解决文档编写困难症提供了一个行之有效的方法。

这正是:

文档编写困难症,递增文档有作用

大型任务被拆分,编写相对容易行

参考书目:极简项目管理:让目标落地、把事办成并使成功可复制的方法论,作者:郭致星,出版社:机械工业出版社

(0)

相关推荐