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