SuperAPI AI 工具集

adr-management

设计与创作

查看项目

更新于 10-16 08:00

技能介绍

用途:管理架构决策记录(ADR),作为项目技术选择的机构记忆,确保重要架构决策被永久记录。自动在生成架构决策、记录设计理由、维护决策日志时调用。

主要能力:提供 ADR 管理脚本 ../../scripts/adr_manager.py,支持 create、list、get、search 子命令;提供编号生成脚本 ../../scripts/next_number.py,可跨 Specs、Tasks、ADRs、Business Rules/Workflows 等工件识别下一个序号。

使用方式:创建 ADR 时运行创建子命令,例如 python3 ./scripts/adr_manager.py create "Use Python 3.12" --context "..." --decision "..." --consequences "...",脚本自动确定下一个顺序 ID 并生成基础模板,路径默认位于项目根目录的 ADRs/,同时将生成的 .md 路径打印到 stdout;随后打开文件,根据对话上下文填写各章节,并基于软件工程知识补充后果与备选方案。列举命令:python3 ./scripts/adr_manager.py list 或 list --limit 10;查看指定 ADR:python3 ./scripts/adr_manager.py get 42;关键词搜索:python3 ./scripts/adr_manager.py search "ChromaDB";序号解析:python3 ./scripts/next_number.py --type adr。

状态与引用:新 ADR 通常为 Proposed 或 Accepted;若新 ADR 使旧 ADR 失效,将旧 ADR 状态改为 Superseded 并链接新 ADR;引用时按编号,例如 “This builds upon the database choice outlined in ADR-0003.”

最佳实践与限制:不要留空任何章节,应基于软件工程知识推断上下文与后果;文件名使用 kebab-case,格式为 NNN-short-descriptive-title.md。资料未提供收费、价格、平台及其他实现细节。