你应该什么时候写架构决策记录(ADR)?
When should you write an architecture decision record (ADR)?
通过架构决策记录 (ADR) 记录您的软件架构似乎被视为软件开发的最佳实践。
对该主题有影响的内容包括以下内容:
- https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions
- https://www.thoughtworks.com/radar/techniques/lightweight-architecture-decision-records
- https://adr.github.io/
为什么 和 如何 对我来说很清楚。我的问题是“什么时候 你应该写一个 ADR?”或者用稍微不同的话来说,“你应该在 ADR 中捕获什么?”
嗯,对于 ADR 流程应该是什么样子,众说纷纭。
我发现以下是最有用的:
- 每当您需要介绍一项技术或程序时,请创建一个新记录
- 并且您已完成评估
- 定期修改它们(每季度一次就足够了)
- 用它来推理你的系统
ADR 将通过捕获您为什么选择 X 以及为什么排除 Y 和 Z 来做出简洁的决定。这些决定无法从您的代码中读取,因此必须记录它们。
并且不要忘记它们是动态文档。正是在不断迭代的过程中,才让它们up-to-date变得有价值。
通过架构决策记录 (ADR) 记录您的软件架构似乎被视为软件开发的最佳实践。
对该主题有影响的内容包括以下内容:
- https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions
- https://www.thoughtworks.com/radar/techniques/lightweight-architecture-decision-records
- https://adr.github.io/
为什么 和 如何 对我来说很清楚。我的问题是“什么时候 你应该写一个 ADR?”或者用稍微不同的话来说,“你应该在 ADR 中捕获什么?”
嗯,对于 ADR 流程应该是什么样子,众说纷纭。
我发现以下是最有用的:
- 每当您需要介绍一项技术或程序时,请创建一个新记录
- 并且您已完成评估
- 定期修改它们(每季度一次就足够了)
- 用它来推理你的系统
ADR 将通过捕获您为什么选择 X 以及为什么排除 Y 和 Z 来做出简洁的决定。这些决定无法从您的代码中读取,因此必须记录它们。
并且不要忘记它们是动态文档。正是在不断迭代的过程中,才让它们up-to-date变得有价值。