如果你在Git 仓库与代码托管平台里反复做二分定位缺陷,可以考虑把经验沉淀为一个 Skill:写清触发条件、步骤、输出格式和边界,让智能体代劳重复部分,人只负责把关。

本文以「二分定位缺陷」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。

完整示例

---
name: git-bisect-helper
description: 用 git bisect 定位引入缺陷的提交。当用户提到二分定位缺陷、或给出好坏版本与复现命令并希望得到问题提交时使用。
---

# 二分定位缺陷

## 输入
- 好坏版本与复现命令
- 若缺少关键信息,先列出需要补充的问题

## 步骤
1. 确认好坏版本
2. 编写自动判定脚本
3. 运行二分
4. 分析问题提交

## 输出
- 问题提交
- 末尾附「需人工确认」清单(没有则写“无”)

## 约束
- 改写历史、删除分支类操作只给建议,不直接执行。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。

## 脚本
- 需要解析或批量处理时运行 `python scripts/git_bisect_helper.py <路径>`,读取其输出后再总结

第一段:name

name 用小写字母和连字符,例如 git-bisect-helper,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。

第二段:description(最关键)

智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(用 git bisect 定位引入缺陷的提交),什么时候用(用户提到二分定位缺陷或给出好坏版本与复现命令时)。

反例:“一个很有用的二分定位缺陷工具”——没有触发条件,智能体很难对上号。

第三段:输入与步骤

输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:

  1. 确认好坏版本
  2. 编写自动判定脚本
  3. 运行二分
  4. 分析问题提交

步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。

第四段:输出

写明交付物(问题提交)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。

第五段:约束

约束写的是不能做什么、遇到什么情况要停下:

  • 改写历史、删除分支类操作只给建议,不直接执行。
  • 信息不足时先提问,不要自行编造数据或事实。
  • 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。

渐进式加载:把长资料拆出去

团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。需要确定性处理的部分(解析、统计、校验)写成脚本放在 scripts/ 下,正文中说明调用方式。

目录结构

.claude/skills/git-bisect-helper/
├── SKILL.md
├── scripts/git_bisect_helper.py
└── reference.md      # 可选:团队规范、模板等长资料,按需加载

写完之后

用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。

什么时候用这个技能

  • 手头有好坏版本与复现命令,需要在较短时间内得到问题提交
  • 同类任务每周出现多次,希望每次处理方式一致
  • 结果要交给同事或上级复核,需要统一的结构和清楚的依据
  • 新人接手这类工作,需要一个可以照着做的标准流程

反过来,如果只是偶尔做一次,或者任务高度依赖现场判断,直接和Git 仓库与代码托管平台里的智能体对话即可,不必专门封装成技能。

延伸阅读

说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。