用途:管理架构决策记录(ADR),为项目的技术选择建立可长期追溯的档案,确保重要架构决策被永久记录在 docs/architecture/decisions/ 目录(默认位置为项目根目录的 ADRs/)。
主要能力:通过脚本创建 ADR 并自动生成下一个顺序编号与模板文件;支持列出、查看指定编号、按关键词搜索 ADR;可用 next_number.py 解析 Specs、Tasks、ADR、业务规则等领域的下一个编号。
使用方式:安装依赖需 Python 3.8+,仅用标准库,可执行 pip-compile ./requirements.in 与 pip install -r ./requirements.txt。脚本需用根相对路径调用:python ./scripts/adr_manager.py <command> 和 python ./scripts/next_number.py --type adr。创建示例:python ./scripts/adr_manager.py create "Use Python 3.12" --context "..." --decision "..." --consequences "..."。生成后编辑各节内容,状态通常用 Proposed 或 Accepted;若新 ADR 取代旧 ADR,需把旧记录状态改为 Superseded 并链接新编号。
适用场景:需要沉淀技术决策依据、维护决策日志、按编号交叉引用 ADR 的工程团队。
限制:需遵循 NNN-short-descriptive-title.md 命名规范;所有章节应填满,不留下空白;官方说明未提供更多平台或收费信息。