软件开发文档与需求管理全解析
1. 软件开发标准与额外阅读资源
在软件开发领域,有一系列重要的标准可供参考:
- IEEE Std. 1063 - 2001:软件用户文档标准。
- IEEE Std. 1074 - 2006:软件开发项目生命周期流程标准。
- IEEE Std. 1223 - 1998:系统需求规格开发指南。
- IEEE Std. 1471 - 2000:软件密集型系统架构描述推荐实践。
此外,还有一些额外的阅读资源,如 Lethbridge、Singer 和 Forward 在 2003 年 11 - 12 月发表于 IEEE Software 的文章 “How software engineers use documentation: the state of the practice”,探讨了行业(主要是非嵌入式行业)中文档使用的研究结果,指出实践中文档看似有价值,但并不总是能及时更新。
2. 文档数量的权衡
在软件开发中,适量的文档对设计有支持作用,但过多的文档则可能造成浪费。文档是否有用,取决于在其缺失时是否会使某人的工作更困难,或者是否有人认为它值得更新。我们应努力让基本文档变得有用且值得维护。
2.1 概述
完全不生成文档(包括电子文档)并非明智之举,但单纯为了有文档而增加数量也不一定更好。我们需要批判性地审视在自身情况下,合适的文档数量是多少。
- 保留有用文档的重要性 :避免无用文档的难点在于判断哪些文档真正无用。人们很容易因主观原因而判定某文档无用,例如负责创建文档的人可能更愿意花时间编