「版本说明」的 SKILL.md 怎么写:逐段拆解与完整示例
产品经理与项目经理经常要做「版本说明」这类事:撰写面向用户的版本说明。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。
本文以「版本说明」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。
完整示例
---
name: release-notes-pm
description: 撰写面向用户的版本说明。当用户提到版本说明、或给出上线功能并希望得到版本说明时使用。
---
# 版本说明
## 输入
- 上线功能
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 挑选亮点
2. 用用户语言描述
3. 附使用方法
4. 列出修复
## 输出
- 版本说明
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 优先级与对外承诺需要团队确认。
- 信息不足时先提问,不要自行编造数据或事实。
第一段:name
name 用小写字母和连字符,例如 release-notes-pm,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。
第二段:description(最关键)
智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(撰写面向用户的版本说明),什么时候用(用户提到版本说明或给出上线功能时)。
反例:“一个很有用的版本说明工具”——没有触发条件,智能体很难对上号。
第三段:输入与步骤
输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:
- 挑选亮点
- 用用户语言描述
- 附使用方法
- 列出修复
步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。
第四段:输出
写明交付物(版本说明)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。
第五段:约束
约束写的是不能做什么、遇到什么情况要停下:
- 优先级与对外承诺需要团队确认。
- 信息不足时先提问,不要自行编造数据或事实。
渐进式加载:把长资料拆出去
团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。
目录结构
.claude/skills/release-notes-pm/
├── SKILL.md
└── reference.md # 可选:团队规范、模板等长资料,按需加载
写完之后
用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。
准备一份好范例
在技能的参考资料里放一份你认可的版本说明范例,往往比多写十条规则更有效。好范例应当:
- 来自真实工作,但已去除个人信息和敏感数据
- 体现团队习惯的结构、措辞和详略程度
- 包含一处“需人工确认”的标注示范,让智能体学会如何表达不确定
- 篇幅适中,不要比平时的产出长太多
范例不必多,一到两份即可;太多范例反而会让智能体机械模仿某一份的细节。
延伸阅读
- 版本说明 · 钉钉 AI 助理 版
- 版本说明 · 测试用例
- 版本说明 · 极简与进阶
- 进度计划 · SKILL.md 写法
- 需求变更评估 · SKILL.md 写法
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。