知识卡片

过时的架构文档比没有文档更危险

普通读书笔记卡 · 2071

内容

一旦真实架构和架构描述之间出现偏离,这份文档不是”打了折扣”地有用,而是彻底失去价值——因为没人能靠读源代码逆向拼出高层次的整体视角,大家却还在按文档里过时的结构做决策,这比完全没文档更容易让人踩坑。防止这种情况的关键杠杆是保持文档足够精简:只捕获真正重要的架构决定的文档,改动少、容易跟着代码一起更新;试图记录所有细节的文档必然频繁过时,也没人有精力去维护它的同步。

参考来源

- 位置:第13章《创建架构描述》13.1.6节「最新」(源文件:_epub-src/OEBPS/text00162.html附近) - 结论依据:原文明确指出一旦架构偏离架构描述,架构描述就变得毫无价值、不再受信任,也无法用源代码逆向拼出高层视角,并建议限制架构描述只包含重要信息以便于保持一致,直接支持卡片结论。 - 原始内容:"一旦架构偏离架构描述,那么架构描述就变得毫无价值。它不再受到信任,也不再会作为架构明确的信息来源使用。然而,你无法通过检查源代码来度量架构的重要属性和质量……越小、越简洁的架构描述就越容易保持一致……试图定义系统所有细节的结构描述会经常处于变化之中,而只定义了架构重要内容的架构会易于保持一致和相关。"