文档精简化的一种思路

编写文档是程序员永远的痛。大多数程序员宁愿多写几行代码,也不愿写文档。然而,对于实施CMMIGJB5000A的企业来说,文档是无法回避的一个问题,没有这些文档,诸如验证与确认、组织过程改进等实践都将失去有力的支持。采用灵活的文档架构——静态文档和动态文档,可能会在一定程度上简化程序员的文档工作

在使用文档的过程中,大家都有一个共识,就是:如果一个文档中包含越多的信息,大家越不太可能去完整阅读这个文档

所以要精简文档,首先就要想一想对于利益相关方什么信息是必须的,信息使用的频率和用途。根据这些判断,确定文档中必须包含的信息,并把它生成动态的、需要持续改进和维护的文档(也是纳入配置管理的文档)。对于其它的信息,在整个软件生命周期中都可能根本不会发生改变的信息,就把它生成静态文档,放在项目组便于查询和取阅的地方(比如开发库)。

把一份内容博杂烦琐的文档,拆分成静态文档和动态文档,程序员仅需要维护必要的动态信息,他们的文档工作就会被简化。

实际上,很多文档确实存在着大量的各个项目都通用的那些信息。GJB 438B中要求的软件研制任务书格式规定的那些内容为例,像6.2标准、6.3文档、6.4配置管理……都是可以做成静态文档的部分。

所以只要认真分析文档内容中哪些是各利益相关方真正关心的内容,哪些是可能在开发过程中会发生变化需要控制的内容,就可以把文档拆分成不变的静态文档和变化的受控的动态文档。

这种静态文档通常可被用作参考,它们只会在过程改变时才会被更新。这些文档的意义是可以给新成员提供一种流程如何工作的高层次理解

让项目团队专注于那些真正需要关注的动态内容,那么他们在文档编写和维护上浪费的时间就会减少很多

如果只维护动态文档依然让你的团队感到很大的负担,那你可能不得不考虑成立一个技术文档编写团队来承担这个任务。

部分内容来自敏捷软件测试。

题图来自网络。

微信号:IdeaofSE

来源:软件工程之思,本文观点不代表自营销立场,网址:https://www.zyxiao.com/p/98587

发表评论

电子邮件地址不会被公开。 必填项已用*标注

侵权联系
分享本页
返回顶部