mcpField
C
create-adr

create-adr

github.com/emiliosheinz开发2039 次安装2 周前更新
代码仓库

关于 create-adr

create-adr 是用于将已确定的决策记录为架构决策记录（ADR）的工作流技能。它引导用户完成字段校验、格式与编号选择、起草和质量检查，并将 ADR 作为历史记录维护。

主要功能

  1. 01校验 ADR 必填字段
  2. 02支持 MADR、Nygard 和 Y-Statement
  3. 03分配连续文档编号
  4. 04检查权衡与文档质量
  5. 05写入前要求确认

适用场景

  1. 01记录已敲定的架构决策
  2. 02为团队记录选择 ADR 格式
  3. 03通过新 ADR 取代旧决策

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/emiliosheinz/agent-skills --skill create-adr

安装后在 Claude Code 中输入/create-adr确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

README.md
references/
formats.md
numbering.md
process.md
quality.md
templates/
adr-madr.md
adr-nygard.md
adr-y-statement.md

详细介绍

创建 ADR

每次调用生成一份 ADR。ADR 用于记录已经做出的决策；如果决策尚未确定，请使用 /create-rfc。按顺序执行五步流程：第 2 步验证必填字段，所有必填字段齐全后即可开始起草。

硬性规则

  • 绝不编造事实。 如果缺少必填字段，就提问。绝不在 Context、Decision 或 Consequences 中填入听起来合理的空话。
  • 绝不编辑现有 ADR 来更改决策。 应通过新 ADR 取代旧 ADR，并建立链接。ADR 是历史记录。
  • 绝不跳过权衡取舍。 Consequences 必须如实说明，包括哪些方面会变得更困难，而不仅是哪些方面会变得更容易。
  • 使用用户的语言撰写——也就是用户在本次会话中使用的语言；文档的每个章节都要使用该语言。

分派流程

按顺序执行流程。采取行动前，完整阅读对应的参考文件——它是该步骤的操作指南。

步骤阅读目的
1 — 收集背景信息references/process.md询问决策、格式、状态、取代的 ADR
2 — 验证必填字段references/process.md确认标题、日期、状态、背景、决策、后果均已提供
3 — 选择格式references/formats.mdMADR（默认）/ Nygard / Y-Statement
4 — 分配编号references/numbering.md扫描目录，分配下一个连续编号
5 — 生成并放置文件references/process.md + templates/adr-{madr,nygard,y-statement}.md 之一填写模板、运行质量检查清单、确认文件位置

定稿前运行质量检查清单（references/quality.md）——检查标题、权衡取舍是否诚实、实际比较过的选项以及命名约定。

模板

纯 Markdown 框架；只加载所选格式对应的模板：

格式模板
MADR（默认）templates/adr-madr.md
Nygardtemplates/adr-nygard.md
Y-Statementtemplates/adr-y-statement.md

通用规则

  1. 诚实。 如实记录权衡取舍、未知事项和未决问题。绝不通过编造答案来掩盖缺口。如果无法填写某个字段，就提问或留下斜体占位内容（*to be confirmed*）。
  2. 不可变性。 ADR 是历史记录。事后绝不修改决策——应通过新 ADR 取代旧 ADR，并在旧 ADR 中添加 Superseded by ADR-{NNN} 链接。
  3. 简短为佳。 理想长度为 200–500 词。如果更长，请将详细内容移至带链接的设计文档或 RFC。
  4. 所有内容注明日期。 现在看来显而易见的事情，三年后未必如此。
  5. 写入前先确认。 在第 5 步建议文件路径；只有用户确认放置位置后才写入。

相关技能

在流程中的任何阶段都可以使用以下技能：

  • /create-rfc — 决策尚未做出。使用 RFC 提出选项、征求反馈并推动达成共识。决策确定后，再回到 /create-adr 进行记录。
  • /forge — 规范驱动的实现。当 ADR 已确定且需要构建对应内容时，使用 /forge specify | design | plan | execute。ADR 通常会作为链接放入 forge design.md 中。

致谢

基于 Tech Leads Club 的 create-adr，采用 CC-BY-4.0 许可。已对原内容进行修改。

评论

支持 Markdown