SuperAPI AI 工具集

architecture-decision-records

通用与其它

查看项目

更新于 10-16 07:22

技能介绍

用途:该技能面向需要记录重大技术决策的团队,用于创建、维护和管理架构决策记录(ADR),把决策的背景、决定与后果沉淀为可追溯文档。

主要能力:提供标准、轻量、Y-statement 等 ADR 模板,以及弃用 ADR 与 RFC 模板;给出 ADR 生命周期(Proposed → Accepted → Deprecated → Superseded,另有 Rejected);提供目录结构示例(docs/adr/ 下含 README.md 索引、template.md 与编号文件);提供评审清单(提交前、评审中、接受后)与最佳实践(尽早写、保持简短、如实记录权衡、链接相关决策、及时更新状态;不要修改已接受的 ADR,应新建 ADR 取代)。

使用方式:先按需阅读对应模板,再复制 template.md 为 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"。

适用场景:做出重大架构决策、记录技术选型、记录设计权衡、新人入职、回顾历史决策、建立决策流程。

限制:资料未提供具体收费、价格、平台支持范围或效果数据;是否适用于非文档类项目暂未提供。