SuperAPI AI 工具集

architecture-decision-records

写作与研究

查看项目

更新于 10-16 03:39

技能介绍

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

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

使用方式:在 docs/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"。

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

限制:资料未提供具体收费、平台支持范围或效果保证;模板中的示例内容仅为示范,实际决策需团队自行判断。