SuperAPI AI 工具集

adr-management

编程与开发

查看项目

更新于 10-16 00:23

技能介绍

用途:在软件项目中创建与管理架构决策记录(ADR),用于记录技术选型、设计决策或架构变更,说明为何选择某种方案而非其他替代方案,并保留决策历史,便于团队入职与后续检索。关键词包括 adr、architecture decision record、decision log、why we chose、alternatives considered、design decision、technology choice。

主要能力:确定下一个 ADR 编号(顺序编号 0001、0002 等);在 /architecture/adr/ 下创建文件,命名格式为 NNNN-title-in-kebab-case.md,使用 references/adr-template.md 模板;填写状态(初始为 Proposed)、日期(YYYY-MM-DD)、Context、Decision、Consequences 等章节;记录替代方案及其优缺点与未采用原因;可选生成上下文图(需可视化插件,使用 visualization:diagram-generator 代理或 visualization:diagram-patterns 技能)。状态包括 Proposed(讨论中)、Accepted(已批准实施)、Deprecated(不再相关但保留历史)、Superseded(被新 ADR 取代)。取代时更新旧 ADR 状态为“Superseded by ADR-XXXX”,并在新 ADR 的 Related Decisions 中引用旧 ADR。创建前可搜索已有决策:ls /architecture/adr/ 或 grep -r "keyword" /architecture/adr/。

使用方式:由用户直接调用时创建新 ADR,流程为扫描 /architecture/adr/ 确定编号、按模板创建文件(状态 Proposed、当前 UTC 日期、标题取自参数),并报告文件路径以便补全内容。示例:/ea:adr-management Use PostgreSQL for persistence;/ea:adr-management Adopt microservices architecture。目录不存在需先创建。

适用场景与限制:适合记录技术选型、设计权衡与架构演进,支持与架构原则链接(如“This decision implements Principle P1”)。最佳实践包括一个 ADR 只记一个决策、历史不可删除只能取代、链接相关 ADR、包含上下文并如实记录负面后果。若从规格说明提取决策,可使用 spec-driven-development 插件的 /spec:adr:create(存储于 docs/adr/,链接 SPEC-xxx),两种方式均用 MADR 格式且可共存。详细模板(Nygard、MADR、Enterprise)建议用 MCP 工具(perplexity、context7)查询最新实践。版本 v1.0.0(2025-12-05)首次发布。其他收费、平台等细节暂未提供。