开发者经常要做「依赖升级助手」这类事:按变更日志评估依赖升级影响,分批升级并跑测试。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。

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

完整示例

---
name: dependency-upgrade
description: 按变更日志评估依赖升级影响,分批升级并跑测试。当用户提到依赖升级助手、或给出依赖清单与目标版本并希望得到升级计划、改动与测试结果时使用。
---

# 依赖升级助手

## 输入
- 依赖清单与目标版本
- 若缺少关键信息,先列出需要补充的问题

## 步骤
1. 列出可升级依赖
2. 阅读破坏性变更说明
3. 逐个升级并跑测试
4. 记录需要人工处理的问题

## 输出
- 升级计划、改动与测试结果
- 末尾附「需人工确认」清单(没有则写“无”)

## 约束
- 改动前确认有测试与版本控制,一次只改一类问题。
- 结论中不确定的部分单独列出,标注「需人工确认」。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。

## 脚本
- 需要解析或批量处理时运行 `python scripts/dependency_upgrade.py <路径>`,读取其输出后再总结

第一段:name

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

第二段:description(最关键)

智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(按变更日志评估依赖升级影响,分批升级并跑测试),什么时候用(用户提到依赖升级助手或给出依赖清单与目标版本时)。

反例:“一个很有用的依赖升级助手工具”——没有触发条件,智能体很难对上号。

第三段:输入与步骤

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

  1. 列出可升级依赖
  2. 阅读破坏性变更说明
  3. 逐个升级并跑测试
  4. 记录需要人工处理的问题

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

第四段:输出

写明交付物(升级计划、改动与测试结果)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。

第五段:约束

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

  • 改动前确认有测试与版本控制,一次只改一类问题。
  • 结论中不确定的部分单独列出,标注「需人工确认」。
  • 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。

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

团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。需要确定性处理的部分(解析、统计、校验)写成脚本放在 scripts/ 下,正文中说明调用方式。

目录结构

.claude/skills/dependency-upgrade/
├── SKILL.md
├── scripts/dependency_upgrade.py
└── reference.md      # 可选:团队规范、模板等长资料,按需加载

写完之后

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

领域注意事项

「依赖升级助手」属于代码质量领域,使用者多是开发者,工作环境通常是代码仓库与终端。这个领域最重要的一条底线是:改动前确认有测试与版本控制,一次只改一类问题。

建议把这条底线原样写进技能的约束部分,而不是指望智能体自己意识到。同时,在团队内部明确:智能体给出的升级计划、改动与测试结果只是初稿或建议,最终由谁签字确认、出了问题由谁负责。

延伸阅读

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