用途:在做出重要架构决策时,用轻量文档记录决策及其背景与后果。适用于技术选型(数据库、框架、云厂商)、系统或组件设计、团队规范制定、多方案权衡评估,以及会影响后续开发的决策记录。
主要能力:提供 Nygard 格式的 ADR 模板、示例与最佳实践。每份 ADR 包含标题(如 ADR-0001: 采用微服务架构)、状态(Proposed、Accepted、Superseded、Deprecated、Rejected)、背景(问题、约束、需求、现状、冲突因素)、决策(具体选择、原则、变更、负责人)、后果(正面、负面、中性)、备选方案(至少两个,说明内容、优缺点、未选原因)以及可选参考链接。
使用方式:从 /templates/adr-template.md 复制模板,分配下一个顺序编号,填写背景、决策、后果与备选方案,状态先设为 Proposed,团队评审后改为 Accepted,实现 PR 中链接 ADR,部署后更新为 Implemented。建议存放在 /docs/adr/ 或 /architecture/decisions/,用 Markdown 格式并纳入 Git 版本控制。
限制与注意:ADR 一旦接受应保持不可变,用新 ADR 取代旧 ADR;用现在时书写;聚焦“为什么”而非实现细节;避免过于技术化、含糊、缺少备选方案或只列好处。资料未提供具体安装命令、收费信息或平台支持范围。