多语言排版检查 Skill 的 SKILL.md 模板与写作要点
「多语言排版检查」是前端工程师的高频任务。它的输入通常是页面与语言包,期望得到的是问题清单。这类有固定流程、又需要一点判断力的工作,很适合封装成智能体 Skill。
本文以「多语言排版检查」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。
完整示例
---
name: i18n-layout-check
description: 检查长文本语言下的截断与换行问题。当用户提到多语言排版检查、或给出页面与语言包并希望得到问题清单时使用。
---
# 多语言排版检查
## 输入
- 页面与语言包
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 切换语言截图
2. 查找截断与溢出
3. 检查日期数字格式
4. 给出修复
## 输出
- 问题清单
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 视觉与交互结果要在真实浏览器里确认。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
## 脚本
- 需要解析或批量处理时运行 `python scripts/i18n_layout_check.py <路径>`,读取其输出后再总结
第一段:name
name 用小写字母和连字符,例如 i18n-layout-check,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。
第二段:description(最关键)
智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(检查长文本语言下的截断与换行问题),什么时候用(用户提到多语言排版检查或给出页面与语言包时)。
反例:“一个很有用的多语言排版检查工具”——没有触发条件,智能体很难对上号。
第三段:输入与步骤
输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:
- 切换语言截图
- 查找截断与溢出
- 检查日期数字格式
- 给出修复
步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。
第四段:输出
写明交付物(问题清单)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。
第五段:约束
约束写的是不能做什么、遇到什么情况要停下:
- 视觉与交互结果要在真实浏览器里确认。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
渐进式加载:把长资料拆出去
团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。需要确定性处理的部分(解析、统计、校验)写成脚本放在 scripts/ 下,正文中说明调用方式。
目录结构
.claude/skills/i18n-layout-check/
├── SKILL.md
├── scripts/i18n_layout_check.py
└── reference.md # 可选:团队规范、模板等长资料,按需加载
写完之后
用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。
平台选择建议
同一个「多语言排版检查」技能可以落在不同平台上,选择时主要看你在哪里工作、要不要执行代码、要不要接外部系统:
- Claude Code Skill:Claude Code 的 Agent Skills 以文件夹为单位:一个 SKILL.md(YAML 头写 name 与 description)加上可选的脚本和参考资料。智能体平时只看到 description。详见Claude Code Skill 版
- GitHub Copilot 指令与提示文件:GitHub Copilot 支持仓库级自定义指令文件
.github/copilot-instructions.md。详见GitHub Copilot 指令与提示文件 版 - OpenAI Agents SDK:OpenAI Agents SDK 是一个轻量的智能体开发框架。详见OpenAI Agents SDK 版
这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码,可据此排除不支持相应能力的平台。
延伸阅读
- 多语言排版检查 · 极简与进阶
- 多语言排版检查 · 定制指南
- 多语言排版检查 · AGENTS.md 版
- 图表组件 · SKILL.md 写法
- PWA 配置 · SKILL.md 写法
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。