「备份可用性验证」的 SKILL.md 怎么写:逐段拆解与完整示例
如果你在服务器、容器与部署流水线里反复做备份可用性验证,可以考虑把经验沉淀为一个 Skill:写清触发条件、步骤、输出格式和边界,让智能体代劳重复部分,人只负责把关。
本文以「备份可用性验证」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。
完整示例
---
name: backup-verify
description: 定期抽查备份能否恢复,并记录结果。当用户提到备份可用性验证、或给出备份位置与恢复步骤并希望得到验证记录时使用。
---
# 备份可用性验证
## 输入
- 备份位置与恢复步骤
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 选择抽查对象
2. 在隔离环境恢复
3. 校验数据完整性
4. 记录耗时与问题
## 输出
- 验证记录
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 变更类命令先在测试环境演练,并准备好回滚。
- 只输出建议、草稿或命令预览,不执行任何不可逆操作;需要执行时先请用户明确确认。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
## 脚本
- 需要解析或批量处理时运行 `python scripts/backup_verify.py <路径>`,读取其输出后再总结
第一段:name
name 用小写字母和连字符,例如 backup-verify,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。
第二段:description(最关键)
智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(定期抽查备份能否恢复,并记录结果),什么时候用(用户提到备份可用性验证或给出备份位置与恢复步骤时)。
反例:“一个很有用的备份可用性验证工具”——没有触发条件,智能体很难对上号。
第三段:输入与步骤
输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:
- 选择抽查对象
- 在隔离环境恢复
- 校验数据完整性
- 记录耗时与问题
步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。
第四段:输出
写明交付物(验证记录)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。
第五段:约束
约束写的是不能做什么、遇到什么情况要停下:
- 变更类命令先在测试环境演练,并准备好回滚。
- 只输出建议、草稿或命令预览,不执行任何不可逆操作;需要执行时先请用户明确确认。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
渐进式加载:把长资料拆出去
团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。需要确定性处理的部分(解析、统计、校验)写成脚本放在 scripts/ 下,正文中说明调用方式。
目录结构
.claude/skills/backup-verify/
├── SKILL.md
├── scripts/backup_verify.py
└── reference.md # 可选:团队规范、模板等长资料,按需加载
写完之后
用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。
每一步要产出什么
把每一步的中间产出写清楚,智能体就不容易跳步,人也方便定位问题:
- 选择抽查对象:产出一段简短的中间结果,并注明依据来自备份位置与恢复步骤的哪一部分
- 在隔离环境恢复:产出一段简短的中间结果,并注明依据来自备份位置与恢复步骤的哪一部分
- 校验数据完整性:产出一段简短的中间结果,并注明依据来自备份位置与恢复步骤的哪一部分
- 记录耗时与问题:产出一段简短的中间结果,并注明依据来自备份位置与恢复步骤的哪一部分
最后一步之后,再把这些中间结果汇总成验证记录。中间结果可以折叠或省略展示,但在技能指令中要求智能体“先完成再汇总”,能明显减少遗漏。
延伸阅读
- 备份可用性验证 · 常见坑
- 备份可用性验证 · 纯提示词版
- 备份可用性验证 · 检查清单
- Nginx 配置审查 · SKILL.md 写法
- 容量预估 · SKILL.md 写法
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。