SuperAPI AI 工具集

adr-drafting

编程与开发

查看项目

更新于 10-15 21:52

技能介绍

用途:为重大架构变更创建新的架构决策记录(ADR),保留团队做出关键技术决策的原因与权衡。

主要能力:从信息确认到生成最终 Markdown 文件,覆盖发现、起草、评审与创建流程。确认决策标题、状态、背景、决策与后果;检查仓库中已有的 ADR 约定;按标准章节(Title、Status、Context、Decision、Consequences)起草。若仓库无既有约定,默认存放于 docs/architecture/adr,文件名采用零填充编号,如 0001-use-postgresql-for-primary-database.md。

使用方式:先向用户收集最少必要信息,确认是新建而非编辑既有 ADR,并确认文档语言与命名约定。随后搜索 docs/architecture/adr、docs/adr、adr、architecture/adr 等位置,读取 1 至 3 个示例推断编号、文件名、标题格式与语气,确定下一个编号(无历史则从 0001 开始)。起草后向用户展示文件路径、标题、状态与章节预览,获得批准后再创建目录与文件,最后报告路径并停止。

适用场景:用户或智能体已决定某项有意义的架构变更,需要记录理由、方向与权衡时,例如创建 ADR、记录架构决策、编写决策记录或保存重要技术选择的历史。

限制:仅用于新建 ADR,不更新既有 ADR 文件、状态历史或取代链;不得编造用户未提供的理由、约束或结果;若仓库已使用其他 ADR 位置,不应强制使用 docs/architecture/adr;信息过于模糊时应先提问澄清。默认状态为 Proposed,除非用户确认其他状态。