不稳定测试排查 Skill 的 SKILL.md 模板与写作要点
如果你在测试框架与 CI 流水线里反复做不稳定测试排查,可以考虑把经验沉淀为一个 Skill:写清触发条件、步骤、输出格式和边界,让智能体代劳重复部分,人只负责把关。
本文以「不稳定测试排查」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。
完整示例
---
name: flaky-test-triage
description: 多次运行定位偶发失败的测试并分析原因。当用户提到不稳定测试排查、或给出测试命令并希望得到不稳定测试清单与原因分析时使用。
---
# 不稳定测试排查
## 输入
- 测试命令
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 重复运行收集失败
2. 对比失败日志
3. 归类为时序、顺序依赖、外部依赖
4. 给出修复方向
## 输出
- 不稳定测试清单与原因分析
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 生成的测试要先在本地跑通,别只盯覆盖率数字。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
## 脚本
- 需要解析或批量处理时运行 `python scripts/flaky_test_triage.py <路径>`,读取其输出后再总结
第一段:name
name 用小写字母和连字符,例如 flaky-test-triage,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。
第二段:description(最关键)
智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(多次运行定位偶发失败的测试并分析原因),什么时候用(用户提到不稳定测试排查或给出测试命令时)。
反例:“一个很有用的不稳定测试排查工具”——没有触发条件,智能体很难对上号。
第三段:输入与步骤
输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:
- 重复运行收集失败
- 对比失败日志
- 归类为时序、顺序依赖、外部依赖
- 给出修复方向
步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。
第四段:输出
写明交付物(不稳定测试清单与原因分析)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。
第五段:约束
约束写的是不能做什么、遇到什么情况要停下:
- 生成的测试要先在本地跑通,别只盯覆盖率数字。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
渐进式加载:把长资料拆出去
团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。需要确定性处理的部分(解析、统计、校验)写成脚本放在 scripts/ 下,正文中说明调用方式。
目录结构
.claude/skills/flaky-test-triage/
├── SKILL.md
├── scripts/flaky_test_triage.py
└── reference.md # 可选:团队规范、模板等长资料,按需加载
写完之后
用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。
交付物结构示例
建议把不稳定测试清单与原因分析固定成下面的结构(示意),方便复核与归档:
## 结论
一句话说明最重要的发现或结果
## 主要内容
- 重复运行收集失败:……
- 对比失败日志:……
- 归类为时序、顺序依赖、外部依赖:……
- 给出修复方向:……
## 依据
- 引用输入中的具体位置或数据
## 需人工确认
- ……(没有则写“无”)
结构固定之后,复核的人只要先看“结论”和“需人工确认”两部分,就能快速判断结果能否使用。
延伸阅读
- 不稳定测试排查 · MCP 服务 版
- 不稳定测试排查 · n8n AI Agent 版
- 不稳定测试排查 · 场景实录
- 接口契约测试 · SKILL.md 写法
- 无障碍测试 · SKILL.md 写法
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。