知识卡片
用共同语言检验文档生命力
设计文档是否有效,可看其中的概念有没有进入团队当前的谈话和代码。如果术语从未被使用,文档可能过大、偏离重点,或无人认可;如果团队语言已经演化而文档停在旧模型,继续保留为现行依据会制造混乱。可更新真正有用的文档,把失去作用的版本归为历史,而非仅靠纪律维持所有文档。参见 [[用语言暴露模型缺陷]]。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 原书第02章|Documents and Diagrams · 查看原书依据
If the terms explained in a design document don't start showing up in conversations and code, the document is not fulfilling its purpose.
参考来源
- 位置:《Domain-Driven Design: Tackling Complexity in the Heart of Software》第20章《原书第02章|Documents and Diagrams》(源文件:_epub-src/0321125215_ch02lev1sec4.html)
- 结论依据:原文用文档与通用语言的互动评估其作用:术语应进入当前谈话和代码;模型语言已变而文档滞后时,可将文档归档为历史。
- 原始内容:The easiest way to judge this is to observe the document's interaction with the UBIQUITOUS LANGUAGE . ... If the terms explained in a design document don't start showing up in conversations and code, the document is not fulfilling its purpose. ... It could safely be archived as history, but left active it could create confusion and hurt the project.