SuperAPI AI 工具集

adr-author

通用与其它

查看项目

更新于 10-16 00:31

技能介绍

用途:adr-author 是供 ADR Creator 智能体使用的分阶段 ADR 撰写技能,也可在无 ADR Creator 状态文件时直接调用。直接调用者需先执行 adr-identity.instructions.md 中的会话恢复与引导协议:解析或创建 .copilot-tracking/adr-plans/{projectSlug}/state.json,确认 entryMode、projectSlug、outputTemplate,再从状态记录的阶段继续。

主要能力:支持三种入口模式——capture(由用户回答 Frame 与 Decide 问题交互撰写)、from-planner-handoff(来自上游规划器,Frame 字段预填但仍需用户确认)、adopt-template(一次性导入既有 ADR 模板,产出首个 ADR 与 .adr-config.yml)。输出模板两种:y-statement(紧凑 Y-Statement,适用于低风险或可逆决策)与 madr-v4(长格式 MADR v4.0.0,适用于架构重要决策,Frame 阶段须评估 ASR 触发)。入口模式与输出模板相互独立。

使用方式:生命周期为 Frame → Decide → Govern(adopt-template 为 Ingest → Normalize → Derive Questions → Fill → Govern)。Frame 需记录范围、决策者、驱动因素、约束、ASR 触发(madr-v4 时)及 diagramFormat,用户确认后方可推进。Decide 至少需两个备选方案、选定方案与理由,并记录负面后果。Govern 是唯一写盘阶段,负责 MADR v4 frontmatter 组装、图表渲染、血缘校验、frontmatter 校验、血缘分配与最终写入 docs/planning/adrs/{NNNN}-{slug}.md,并触发交接工作项。相关脚本包括 render_template.py、validate_frontmatter.py、update_lineage.py、normalize_template.py、scan_sensitive_content.py。

适用场景与限制:适用于需要规范化记录架构决策、维护取代血缘与状态分类(proposed、accepted、rejected、deprecated、superseded、withdrawn)的团队。ASR 触发为封闭枚举八值,不得引入枚举外值。last_decision_id 仅由 update_lineage.py 写入,禁止手工修改。所有脚本将工作目录视为不可信输入并做路径穿越防护。持久写入 ADR 及外部或交接输出前必须运行敏感内容扫描。具体收费、价格与平台信息暂未提供。