软件开发中纸质文档的合理使用
在软件开发的过程中,纸质文档(包括电子文档)的使用是一个值得深入探讨的话题。适量的文档可以为设计提供支持,但过多的文档则可能造成资源浪费。下面我们就来详细探讨如何确定合适的文档数量以及避免无用文档的产生。
1. 概述
在软件开发中,完全不生成文档是不可取的,但仅仅为了有文档而生成大量文档也不一定是好事。因此,我们需要仔细评估在特定情况下,到底多少文档才是合适的。
1.1 保留有用文档的重要性
避免无用文档的关键在于准确判断哪些文档是真正无用的。然而,人们往往容易出于非客观的原因就判定“这份文档无用”。例如,负责创建文档的人可能更愿意花时间编写代码或者按时下班。
拥有真正有用的文档可以在很大程度上避免问题的产生,提高开发过程的效率。但创建文档需要花费时间和金钱,所以我们要确保生成的每一份文档都能提供价值。如果文档无用,那么要么想办法让它变得有用,要么就将其舍弃。在很多情况下,让文档变得有用是更好的选择,但有时舍弃文档也是最佳策略,关键在于能够准确判断具体情况。
1.2 可能出现的症状
如果出现以下症状,说明你正在生成无用的文档,或者没有从创建文档的努力中获得益处:
- 项目后期创建文档 :文档在项目接近尾声时才创建,仅作为“文档记录”,而没有在设计过程中发挥作用。这种文档对开发过程没有帮助,不过如果客户因为某些原因要求将其作为软件交付物的一部分,那就是另一回事了。
- 文档之间缺乏关联 :设计包中的某个文档与其他文档没有关联。例如,没有将状态图中的状态与实现的 case
超级会员免费看
订阅专栏 解锁全文
30

被折叠的 条评论
为什么被折叠?



