「前端错误兜底」的 SKILL.md 怎么写:逐段拆解与完整示例
如果你在浏览器、组件库与设计稿里反复做前端错误兜底,可以考虑把经验沉淀为一个 Skill:写清触发条件、步骤、输出格式和边界,让智能体代劳重复部分,人只负责把关。
本文以「前端错误兜底」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。
完整示例
---
name: error-boundary
description: 为页面添加错误边界与友好的出错提示。当用户提到前端错误兜底、或给出页面代码并希望得到改造代码时使用。
---
# 前端错误兜底
## 输入
- 页面代码
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 识别易出错区域
2. 添加兜底组件
3. 记录错误日志
4. 设计用户提示
## 输出
- 改造代码
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 视觉与交互结果要在真实浏览器里确认。
- 信息不足时先提问,不要自行编造数据或事实。
第一段:name
name 用小写字母和连字符,例如 error-boundary,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。
第二段:description(最关键)
智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(为页面添加错误边界与友好的出错提示),什么时候用(用户提到前端错误兜底或给出页面代码时)。
反例:“一个很有用的前端错误兜底工具”——没有触发条件,智能体很难对上号。
第三段:输入与步骤
输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:
- 识别易出错区域
- 添加兜底组件
- 记录错误日志
- 设计用户提示
步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。
第四段:输出
写明交付物(改造代码)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。
第五段:约束
约束写的是不能做什么、遇到什么情况要停下:
- 视觉与交互结果要在真实浏览器里确认。
- 信息不足时先提问,不要自行编造数据或事实。
渐进式加载:把长资料拆出去
团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。
目录结构
.claude/skills/error-boundary/
├── SKILL.md
└── reference.md # 可选:团队规范、模板等长资料,按需加载
写完之后
用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。
平台选择建议
同一个「前端错误兜底」技能可以落在不同平台上,选择时主要看你在哪里工作、要不要执行代码、要不要接外部系统:
- OpenAI Agents SDK:OpenAI Agents SDK 是一个轻量的智能体开发框架。详见OpenAI Agents SDK 版
- GPTs:GPTs 是在 ChatGPT 中创建的定制版助手。详见GPTs 版
- Gemini CLI:Gemini CLI 会读取项目中的 GEMINI.md 作为长期上下文。详见Gemini CLI 版
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用,可据此排除不支持相应能力的平台。
延伸阅读
- 前端错误兜底 · Dify 工作流 版
- 前端错误兜底 · 快速上手
- 前端错误兜底 · 组合用法
- 前端组件测试 · SKILL.md 写法
- 组件生成 · SKILL.md 写法
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。