SuperAPI AI 工具集

architecture-decision-records

写作与研究

查看项目

更新于 10-16 00:30

技能介绍

用途:该技能面向需要记录重大技术决策的团队,帮助创建、维护和管理架构决策记录(ADR),捕捉决策的背景与理由。适用场景包括做出重大架构决策、记录技术选型、记录设计权衡、新人入职、回顾历史决策以及建立决策流程。

主要能力:提供多种模板,包括标准 MADR 格式、轻量级 ADR、Y-Statement 格式、弃用型 ADR 和 RFC 风格;定义 ADR 生命周期(Proposed → Accepted → Deprecated → Superseded,以及 Rejected);给出目录结构、索引 README 示例、评审清单与最佳实践(如尽早编写、保持简短、诚实记录权衡、用新 ADR 取代已接受 ADR)。

使用方式:复制模板为 NNNN-title-with-dashes.md,填写后提交 PR 评审,批准后更新索引。可用 adr-tools 自动化:brew install adr-tools;adr init docs/adr;adr new "Use PostgreSQL as Primary Database";adr new -s 3 "Deprecate MongoDB in Favor of PostgreSQL";adr generate toc > docs/adr/README.md;adr link 2 "Complements" 1 "Is complemented by"。

限制:资料未提供该技能的安装方式、收费、平台支持或实际效果等信息,暂未提供。