知识卡片

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

专业/工作

内容

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

参考来源

《软件系统架构:使用视点和视角与利益相关者合作》第13章《创建架构描述》