知识卡片

普通读书笔记卡 · 4666

文档要写未采纳的方案

理解等级:初级

设计文档里最重要的一项内容,是没有采纳的设计备选方案以及没采纳的原因。这部分最容易被遗忘,却往往最有用:代码只能说明最终选了什么,说明不了为什么没选别的。缺了它,后来的维护者容易把已经否决过的方案再试一遍,或者把出于权衡的设计误当成随意之举。发散:架构决策记录的价值主要就在“考虑过但放弃的选项”这一栏。参见[[精选备忘录优于详尽文档]]。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • 开发过程 · 查看原书依据

      文档中最重要的一项内容是你没有采纳的设计备选方案以及没有采纳的原因。这是你可以提供的外部文档中,经常最容易忘记、但最有用的部分。

    参考来源

    - 位置:《UML精粹:标准对象建模语言简明指南(第3版)》第2章《开发过程》2.6.3节(源文件:`_epub-src/EPUB/1.xhtml`) - 结论依据:原文指出外部文档中最重要的一项是没有采纳的设计备选方案及原因,它最容易被遗忘却最有用。 - 原始内容:文档中最重要的一项内容是你没有采纳的设计备选方案以及没有采纳的原因。这是你可以提供的外部文档中,经常最容易忘记、但最有用的部分。