SuperAPI AI 工具集

architecture-decision-records

通用与其它

查看项目

更新于 10-16 09:35

技能介绍

用途:为团队建立、维护和管理架构决策记录(ADR),把重大技术决策的背景、约束、备选方案与后果留存下来,便于评审历史决策与新成员上手。

主要能力:提供标准 ADR(MADR)、轻量 ADR、Y-Statement、弃用 ADR、RFC 风格等多种模板;覆盖决策上下文、决策驱动因素、备选方案对比、最终决策、理由、正负后果与风险、实施说明、相关决策与参考链接。还涉及生命周期(Proposed→Accepted→Deprecated→Superseded,另有 Rejected)与索引、评审清单、最佳实践。

使用方式:在 docs/adr 等目录维护 ADR 文件与 README 索引;可用 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"。

适用场景:框架或数据库选型、API 设计模式、安全架构、集成模式等重大决策,以及决策复审和历史追溯。

限制:不适用于小型实现细节、小补丁或例行维护;已接受的 ADR 不直接修改,应以新 ADR 取代。资料未提供收费、平台支持范围与效果数据。