「架构决策记录」的 SKILL.md 怎么写:逐段拆解与完整示例
把「架构决策记录」交给智能体,难点不在模型能力,而在流程是否说清楚:输入是什么(讨论记录),按什么顺序处理,交付什么(ADR 文档),哪些事不能做。Skill 就是把这些写下来的载体。
本文以「架构决策记录」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。
完整示例
---
name: adr-writer
description: 把技术选型讨论整理为架构决策记录。当用户提到架构决策记录、或给出讨论记录并希望得到ADR 文档时使用。
---
# 架构决策记录
## 输入
- 讨论记录
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 写背景与问题
2. 列出备选方案
3. 记录决策与理由
4. 写后果与复查时间
## 输出
- ADR 文档
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 文中的命令和接口要与当前代码逐一核对。
- 信息不足时先提问,不要自行编造数据或事实。
第一段:name
name 用小写字母和连字符,例如 adr-writer,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。
第二段:description(最关键)
智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(把技术选型讨论整理为架构决策记录),什么时候用(用户提到架构决策记录或给出讨论记录时)。
反例:“一个很有用的架构决策记录工具”——没有触发条件,智能体很难对上号。
第三段:输入与步骤
输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:
- 写背景与问题
- 列出备选方案
- 记录决策与理由
- 写后果与复查时间
步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。
第四段:输出
写明交付物(ADR 文档)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。
第五段:约束
约束写的是不能做什么、遇到什么情况要停下:
- 文中的命令和接口要与当前代码逐一核对。
- 信息不足时先提问,不要自行编造数据或事实。
渐进式加载:把长资料拆出去
团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。
目录结构
.claude/skills/adr-writer/
├── SKILL.md
└── reference.md # 可选:团队规范、模板等长资料,按需加载
写完之后
用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。
交付物结构示例
建议把ADR 文档固定成下面的结构(示意),方便复核与归档:
## 结论
一句话说明最重要的发现或结果
## 主要内容
- 写背景与问题:……
- 列出备选方案:……
- 记录决策与理由:……
- 写后果与复查时间:……
## 依据
- 引用输入中的具体位置或数据
## 需人工确认
- ……(没有则写“无”)
结构固定之后,复核的人只要先看“结论”和“需人工确认”两部分,就能快速判断结果能否使用。
延伸阅读
- 架构决策记录 · 纯提示词版
- 架构决策记录 · 检查清单
- 架构决策记录 · Gemini CLI 版
- 教程编写 · SKILL.md 写法
- 需求拆任务 · SKILL.md 写法
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。