「正则解释与修复」的 SKILL.md 怎么写:逐段拆解与完整示例
把「正则解释与修复」交给智能体,难点不在模型能力,而在流程是否说清楚:输入是什么(正则表达式与样例文本),按什么顺序处理,交付什么(解释、修正版与测试用例),哪些事不能做。Skill 就是把这些写下来的载体。
本文以「正则解释与修复」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。
完整示例
---
name: regex-explain-fix
description: 解释已有正则含义,发现边界问题并给出修正版和测试样例。当用户提到正则解释与修复、或给出正则表达式与样例文本并希望得到解释、修正版与测试用例时使用。
---
# 正则解释与修复
## 输入
- 正则表达式与样例文本
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 逐段解释正则
2. 构造边界样例
3. 找出误匹配
4. 给出修正并用样例验证
## 输出
- 解释、修正版与测试用例
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 改动前确认有测试与版本控制,一次只改一类问题。
- 信息不足时先提问,不要自行编造数据或事实。
第一段:name
name 用小写字母和连字符,例如 regex-explain-fix,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。
第二段:description(最关键)
智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(解释已有正则含义,发现边界问题并给出修正版和测试样例),什么时候用(用户提到正则解释与修复或给出正则表达式与样例文本时)。
反例:“一个很有用的正则解释与修复工具”——没有触发条件,智能体很难对上号。
第三段:输入与步骤
输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:
- 逐段解释正则
- 构造边界样例
- 找出误匹配
- 给出修正并用样例验证
步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。
第四段:输出
写明交付物(解释、修正版与测试用例)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。
第五段:约束
约束写的是不能做什么、遇到什么情况要停下:
- 改动前确认有测试与版本控制,一次只改一类问题。
- 信息不足时先提问,不要自行编造数据或事实。
渐进式加载:把长资料拆出去
团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。
目录结构
.claude/skills/regex-explain-fix/
├── SKILL.md
└── reference.md # 可选:团队规范、模板等长资料,按需加载
写完之后
用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。
领域注意事项
「正则解释与修复」属于代码质量领域,使用者多是开发者,工作环境通常是代码仓库与终端。这个领域最重要的一条底线是:改动前确认有测试与版本控制,一次只改一类问题。
建议把这条底线原样写进技能的约束部分,而不是指望智能体自己意识到。同时,在团队内部明确:智能体给出的解释、修正版与测试用例只是初稿或建议,最终由谁签字确认、出了问题由谁负责。
延伸阅读
- 正则解释与修复 · 检查清单
- 正则解释与修复 · Gemini CLI 版
- 正则解释与修复 · Function Calling 版
- Lint 修复循环 · SKILL.md 写法
- 依赖升级助手 · SKILL.md 写法
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。