知识卡片
文档保存决策语境
架构文档保存的不只是系统现在长什么样,还包括当时掌握的信息、假设和设计理由。这样后续人员才有条件判断原决策是否仍适用,而不会用今天的环境草率否定过去的选择。源代码能展示实现,但未必解释为何选择它或哪些信息值得注意;文档需要由理解问题的人突出这些内容。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 沟通 沟通 · 查看原书依据
文档化有助于理解这些背景信息都是什么。
参考来源
- 位置:《架构师应该知道的37件事》第3章《沟通》之沟通(来源项目:book-sources;源文件:extracted/架构师应该知道的37件事/_epub-src/OEBPS/Text/chapter003.html)
- 结论依据:章首将历史追溯与代码难以解释原因并列,已有卡主要覆盖写作表达,未保留文档的决策语境职责。
- 原始内容:文档化有助于理解这些背景信息都是什么。