3、软件开发中，多少文档才足够？

软件开发中，多少文档才足够？

1. 软件开发中文档现状概述

许多程序员热衷于编写代码，而对编写文档兴趣缺缺。毕竟，编写代码充满乐趣，而文档工作不仅无趣，还面临来自管理层或客户要求快速让软件运行起来的压力。从表面上看，文档既不是可执行代码，也不能直接展现软件功能，在客户演示中也不显眼，客户往往更关注软件是否能正常运行，而非堆积如山的文档。甚至在学校里，编程作业的评分也更侧重于代码是否能正常工作，而非文档是否完善。

一些开发方法提倡尽量减少文档的生成，这本身并非坏事，但前提是要保证生成的文档量恰到好处，而不是过少。

2. 生成足够文档的重要性

生成文档的目的是记录信息，以便他人能够理解项目。虽然有时文档完善的源代码就足够了，但对于嵌入式系统而言，多数情况下并非如此。生成文档需要投入时间和精力，因此需要权衡增加文档所带来的额外成本是否值得。不过，完全不生成文档绝对不是正确的选择。

跳过文档工作，最终会导致总成本增加、生产就绪软件的创建时间延长，还会在后续带来更多麻烦。虽然文档并非越多越好，但如果出现以下问题，就说明文档生成不足：
- 开发人员离职或退休后，为避免项目失败，不得不将其聘回作为顾问。
- 需要更新旧软件时，发现没有足够的信息来理解现有代码，甚至开发者本人也不例外。
- 有人被分配任务去记录或逆向工程已编写和部署的代码，以了解其功能。
- 由于沟通不畅导致重大项目失败或出现严重 bug，如果这些问题被记录下来，本可以避免。
- 与合作伙伴（外包或其他形式）合作时，需要花费大量时间通过电话解决误解。
- 在开发过程中，有人遭遇严重的不愉快意外，例如客户发现预期的功能缺失或运行