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