知识卡片
精选备忘录优于详尽文档
内容
详细文档应从代码本身生成（如JavaDoc），人写的附加文档不该追求覆盖全部细节，而应只强调最重要的概念，作为读者深入代码前的第一步。Ward Cunningham点出关键：精心挑选、编写良好的一小段备忘录，往往能替代面面俱到、实际只有零星几处真正有价值的设计文档，与其平均分配笔墨，不如提升关键点地位、忽略其余部分。这也解释了为什么好文档要用UML草稿而非蓝图。
参考来源
- 位置：《UML精粹：标准对象建模语言简明指南（第3版）》第2章《开发过程》（源文件：_epub-src/EPUB/1.xhtml）
- 结论依据：原文引用Ward Cunningham"小心选出和编写良好的备忘录，可以轻易替换传统的面面俱到的设计文档。后者只有孤立的几个闪光点"，并说明作者据此主张详细文档应从代码生成，人写文档只强调重要概念、优先使用UML草稿而非蓝图。
- 原始内容：小心选出和编写良好的备忘录，可以轻易替换传统的面面俱到的设计文档。后者只有孤立的几个闪光点。提升那些点的地位……忘记剩下的东西。……我更喜欢把图作为草稿，强调系统最重要的部分。