SuperAPI AI 工具集

create-adr

办公与效率

查看项目

更新于 10-15 21:09

技能介绍

用途:当用户要求撰写或新增 ADR、记录某项架构选择及其理由,或某项重要技术决策已定(或即将定稿)需要留档时使用。若决策尚未做出,应改用 create-rfc 先推动决策流程。

主要能力:按工作流收集上下文,校验必填字段(标题为名词短语、日期、状态、上下文、决策本身、后果),推荐补充决策驱动因素、考虑过的选项、各选项利弊、决策理由和相关链接;自动扫描 ADR 目录分配顺序编号;可选用 MADR、Nygard 或 Y-Statement 三种格式,默认 MADR;生成后询问保存位置,建议路径为 docs/adr/{NNN}-{kebab-case-title}.md,文件命名采用零填充序号。可含质量检查清单。

使用方式:以 @create-adr 调用并传入任务;上下文不足时会用 AskQuestion 询问决策内容、格式、状态、是否取代旧 ADR;缺失必填字段时用用户语言追问;随后扫描 docs/adr/、docs/decisions/、.adr/ 或 adr/ 确定下一个编号并生成文档。文档使用用户语言撰写,技术术语可保留英文。

适用场景:团队已做架构决策需要留档、需要解释“为什么选择 X”、为未来工程师保存推理依据。

限制:仅记录已做或正在定稿的决策,不用于决策讨论;ADR 应为不可变文档,被取代而非直接编辑;本技能不涉及具体编程语言实现。资料未提供收费、价格或平台信息。