把「错误码文档」做成 Claude Code Skill:SKILL.md 写法与上手
开发者与技术写作者经常要做「错误码文档」这类事:整理系统错误码及处理建议。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。
本文介绍如何在 Claude Code Skill 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 错误码文档(error-message-doc) |
| 作用 | 整理系统错误码及处理建议 |
| 输入 | 错误码定义 |
| 输出 | 错误码文档 |
| 形态 | 纯提示词 |
| 风险 | 低 |
| 适用人群 | 开发者与技术写作者 |
处理流程分四步:
- 列出错误码与含义
- 写触发原因
- 给出用户与开发者处理建议
- 附示例
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;风险较低,但输出仍需快速过目再使用。
在 Claude Code Skill 中是什么形态
Claude Code 的 Agent Skills 以文件夹为单位:一个 SKILL.md(YAML 头写 name 与 description)加上可选的脚本和参考资料。智能体平时只看到 description,判断相关时才加载全文,所以 description 写得准不准,直接决定 Skill 会不会被用上。
个人级放在 ~/.claude/skills/,项目级放在仓库的 .claude/skills/,随代码一起提交,团队成员拉取后即可使用。
示例配置
.claude/skills/error-message-doc/
├── SKILL.md
└── reference.md # 可选:团队规范、模板等长资料,按需加载
SKILL.md 示例(示意):
---
name: error-message-doc
description: 整理系统错误码及处理建议。当用户提到错误码文档、或给出错误码定义并希望得到错误码文档时使用。
---
# 错误码文档
## 输入
- 错误码定义
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 列出错误码与含义
2. 写触发原因
3. 给出用户与开发者处理建议
4. 附示例
## 输出
- 错误码文档
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 文中的命令和接口要与当前代码逐一核对。
- 信息不足时先提问,不要自行编造数据或事实。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者与技术写作者提出相关请求时能对上号;二是约束部分要写进「文中的命令和接口要与当前代码逐一核对」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在项目根目录新建
.claude/skills/error-message-doc/文件夹 - 写 SKILL.md:先写 name 和 description,再写步骤、输出与约束
- 需要确定性处理的部分放进 scripts/ 目录,在 SKILL.md 中写明何时调用
- 重新启动或新开会话,用一句自然语言描述任务,观察是否自动加载
- 把 Skill 提交到仓库,在 README 或 AGENTS.md 中登记
实操:一次完整的运行
假设你在文档仓库与文档站中发出这样的请求(虚构示例):
用错误码文档技能处理这份错误码定义,输出错误码文档。
智能体识别到任务与「错误码文档」相关后,会依次列出错误码与含义、写触发原因、给出用户与开发者处理建议、附示例。最终交付错误码文档,并在末尾列出需要人工确认的内容。你的工作是对照原始错误码定义抽查两三处关键信息,确认无误后再使用。
测试与验收
在新会话中用三种说法描述同一任务,确认 Skill 都能被触发;再用一个不相关请求确认它不会误触发。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准错误码定义,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- description 写成口号(如“强大的助手”),智能体无法判断何时使用。
- 把大量参考资料塞进 SKILL.md 正文,拖慢每次加载;长资料应拆到单独文件按需读取。
- 只写了步骤,没写交付格式,导致每次输出的错误码文档结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 错误码文档 · 介绍
- 错误码文档 · 常见坑
- 错误码文档 · 纯提示词版
- 配置项说明 · Claude Code Skill 版
- 更新日志生成 · Claude Code Skill 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。