「升级迁移指南」是开发者与技术写作者的高频任务。它的输入通常是版本差异，期望得到的是迁移指南。这类有固定流程、又需要一点判断力的工作，很适合封装成智能体 Skill。

本文以「升级迁移指南」为例，逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式：YAML 头 + Markdown 正文，其结构思路也适用于其他平台的规则文件与指令。

完整示例

---
name: migration-guide-writer
description: 为破坏性版本升级编写迁移指南。当用户提到升级迁移指南、或给出版本差异并希望得到迁移指南时使用。
---

# 升级迁移指南

## 输入
- 版本差异
- 若缺少关键信息，先列出需要补充的问题

## 步骤
1. 列出破坏性变更
2. 写新旧对照
3. 给出迁移步骤
4. 附检查清单

## 输出
- 迁移指南
- 末尾附「需人工确认」清单（没有则写“无”）

## 约束
- 文中的命令和接口要与当前代码逐一核对。
- 信息不足时先提问，不要自行编造数据或事实。

第一段：name

name 用小写字母和连字符，例如 migration-guide-writer，与文件夹名保持一致，方便检索和引用。不要用空格、中文或版本号。

第二段：description（最关键）

智能体平时只看得到 description，靠它判断要不要加载技能。好的 description 同时回答两件事：做什么（为破坏性版本升级编写迁移指南），什么时候用（用户提到升级迁移指南或给出版本差异时）。

反例：“一个很有用的升级迁移指南工具”——没有触发条件，智能体很难对上号。

第三段：输入与步骤

输入写清楚需要什么材料，并要求缺信息时先提问。步骤用编号列表，每步一个动作：

  1. 列出破坏性变更
  2. 写新旧对照
  3. 给出迁移步骤
  4. 附检查清单

步骤是给智能体的执行顺序，不是给人看的说明书，越具体越好。

第四段：输出

写明交付物（迁移指南）以及固定结构。建议统一附上“需人工确认”清单，让复核的人知道看哪里。

第五段：约束

约束写的是不能做什么、遇到什么情况要停下：

  • 文中的命令和接口要与当前代码逐一核对。
  • 信息不足时先提问，不要自行编造数据或事实。

渐进式加载：把长资料拆出去

团队规范、长模板、术语表不要塞进 SKILL.md 正文，放到同目录的 reference.md 等文件中，在正文里写“需要时阅读 reference.md”。这样平时加载很轻，需要时再读取细节。

目录结构

.claude/skills/migration-guide-writer/
├── SKILL.md
└── reference.md      # 可选：团队规范、模板等长资料，按需加载

写完之后

用三种不同说法描述任务，看技能是否都能被触发；再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。

交付物结构示例

建议把迁移指南固定成下面的结构（示意），方便复核与归档：

## 结论
一句话说明最重要的发现或结果

## 主要内容
- 列出破坏性变更：……
- 写新旧对照：……
- 给出迁移步骤：……
- 附检查清单：……

## 依据
- 引用输入中的具体位置或数据

## 需人工确认
- ……（没有则写“无”）

结构固定之后，复核的人只要先看“结论”和“需人工确认”两部分，就能快速判断结果能否使用。

延伸阅读

说明：文中的配置、代码与目录结构均为示意，用于说明思路；各平台的入口、字段名与能力会更新，落地前请以对应官方文档为准。示例中的数据与场景为虚构，不代表真实案例。