SuperAPI AI 工具集

architecture-decision-records

部署与运维

查看项目

更新于 10-15 21:10

技能介绍

用途:为架构上重要的单个决策留下持久记录,说明为何这样选择。偏好简短、基于事实的记录,而非宽泛的设计指南。

主要能力:判断记录是前瞻性还是回溯性;识别单一重要决策,将独立、分阶段或可分别回退的选择拆分为多条记录;使用仓库既有模板,无模板时采用 Nygard 最小结构(状态、背景、决策、后果),需要选项比较时用 MADR;回溯记录先查 Git 历史并记录 commit 哈希与日期,再对照当前代码、测试、配置和权威平台文档核实;写明约束与权衡、决策本身及其收益、成本、风险与限制;状态使用 Proposed、Accepted、Rejected、Deprecated 或 Superseded by ADR-NNN,保留已接受与已否决记录,通过新 ADR 取代而非改写历史;更新决策日志索引与双向取代链接,用仓库原生工具链渲染或检查文档。

质量规则:标识符单调递增且不复用;一条记录一个决策;区分观察到的事实、所选决策与预期后果;包含可信备选而非稻草人选项;未定义评分模型并引用测量依据时不得给出净分或权重;区分已核实历史与推断、当前政策与过往事实;证据中不得含密钥、个人数据或凭据;记录保持简洁、独立、可链接、可在代码 diff 中评审。

用法:运行内置校验器,例如:python3 skills/architecture-decision-records/scripts/validate_adrs.py docs/adr
--git-repo . --require-history。前瞻性记录省略 --require-history,之后再加上仓库自己的渲染器、链接检查器或 Markdown/ReST 检查器。

运行中流程的决策:某些技能在工作进行中把决策写入 .typo3-update/decisions/(如 typo3-upgrade-run)而非项目永久 docs/adr。此时有两条规则:削弱保证的 ADR 必须明确说明,且该削弱也必须出现在声明该保证的证书或报告中;在循环关闭前而非项目结束时校验:python3 skills/architecture-decision-records/scripts/validate_adrs.py
.typo3-update/decisions。运行范围的 ADR 留在其运行中,只有超出产生它的流程寿命时才提升到项目永久决策日志。

资源:references/best-practices.md 含标准全景、生命周期、证据方法与评审细则;assets/adr-template.md 用于 Markdown 项目;assets/AdrTemplate.rst 用于 TYPO3 等 ReST 文档项目。限制:适用于 TYPO3 相关技能仓库;具体平台支持与收费方式暂未提供。