SuperAPI AI 工具集

decision-records

通用与其它

查看项目

更新于 10-16 05:48

技能介绍

用途:本技能围绕架构决策记录(ADR)的集合维护,负责按集合自身既有约定创建记录、取代旧记录并校验一致性,而不是强推某套公开模板。

主要能力:先运行校验脚本报告集合的命名方案、状态存放位置与用词、多数记录包含的章节及索引,作为后续写作依据。创建时在对话中起草,等待明确批准后才写入磁盘;编号方案取最大值加一,不复用已删除编号;同一轮更新索引并重跑校验。取代时新建记录并在旧记录状态中标注 superseded by 新引用,不修改已接受记录的决策内容。校验脚本 check-decisions.sh [--require "A,B"] [--status "a,b"] [--portable] DIR 提供八项检查(NAME、SECTION、STATUS、DRIFT、SUPERSEDE、DUPLICATE、INDEX、PORTABLE),退出码 0 表示干净、1 表示违规、2 表示用法错误或无可检查内容。

使用方式:先执行脚本查看约定报告,再按方案起草并等待批准,写入后更新索引并复跑校验。空集合或不存在时询问一次并提供 NNNN-slug.md 与 YYYY-MM-DD-slug.md 两种方案,并行 PR 场景推荐日期方案。

适用场景:维护已有 ADR 集合、需要取代旧决策、检查索引与目录是否一致、检查记录可移植性(绝对路径与越出集合的链接)时。

限制:不在目标仓库创建 template.md;不检查私密令牌,隐私检查属 privacy-guard 技能;不重写已接受记录来改变决定;--portable 只检查复制后失效的路径与链接。STATUS 与 DRIFT 假设状态字段是单个词,若状态字段为段落文本,推导词汇无意义,不要在该集合上使用 --status。空目录退出码为 2 而非 0。