「分支清理」的 SKILL.md 怎么写:逐段拆解与完整示例
「分支清理」是开发团队的高频任务。它的输入通常是仓库分支列表,期望得到的是清理清单。这类有固定流程、又需要一点判断力的工作,很适合封装成智能体 Skill。
本文以「分支清理」为例,逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式:YAML 头 + Markdown 正文,其结构思路也适用于其他平台的规则文件与指令。
完整示例
---
name: branch-cleanup
description: 找出已合并或长期无更新的分支并给出清理建议。当用户提到分支清理、或给出仓库分支列表并希望得到清理清单时使用。
---
# 分支清理
## 输入
- 仓库分支列表
- 若缺少关键信息,先列出需要补充的问题
## 步骤
1. 列出远程分支
2. 判断是否已合并
3. 按最后提交时间排序
4. 输出建议而不直接删除
## 输出
- 清理清单
- 末尾附「需人工确认」清单(没有则写“无”)
## 约束
- 改写历史、删除分支类操作只给建议,不直接执行。
- 结论中不确定的部分单独列出,标注「需人工确认」。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
## 脚本
- 需要解析或批量处理时运行 `python scripts/branch_cleanup.py <路径>`,读取其输出后再总结
第一段:name
name 用小写字母和连字符,例如 branch-cleanup,与文件夹名保持一致,方便检索和引用。不要用空格、中文或版本号。
第二段:description(最关键)
智能体平时只看得到 description,靠它判断要不要加载技能。好的 description 同时回答两件事:做什么(找出已合并或长期无更新的分支并给出清理建议),什么时候用(用户提到分支清理或给出仓库分支列表时)。
反例:“一个很有用的分支清理工具”——没有触发条件,智能体很难对上号。
第三段:输入与步骤
输入写清楚需要什么材料,并要求缺信息时先提问。步骤用编号列表,每步一个动作:
- 列出远程分支
- 判断是否已合并
- 按最后提交时间排序
- 输出建议而不直接删除
步骤是给智能体的执行顺序,不是给人看的说明书,越具体越好。
第四段:输出
写明交付物(清理清单)以及固定结构。建议统一附上“需人工确认”清单,让复核的人知道看哪里。
第五段:约束
约束写的是不能做什么、遇到什么情况要停下:
- 改写历史、删除分支类操作只给建议,不直接执行。
- 结论中不确定的部分单独列出,标注「需人工确认」。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
渐进式加载:把长资料拆出去
团队规范、长模板、术语表不要塞进 SKILL.md 正文,放到同目录的 reference.md 等文件中,在正文里写“需要时阅读 reference.md”。这样平时加载很轻,需要时再读取细节。需要确定性处理的部分(解析、统计、校验)写成脚本放在 scripts/ 下,正文中说明调用方式。
目录结构
.claude/skills/branch-cleanup/
├── SKILL.md
├── scripts/branch_cleanup.py
└── reference.md # 可选:团队规范、模板等长资料,按需加载
写完之后
用三种不同说法描述任务,看技能是否都能被触发;再用一个无关请求确认不会误触发。之后参考测试用例与效果评估持续改进。
什么时候用这个技能
- 手头有仓库分支列表,需要在较短时间内得到清理清单
- 同类任务每周出现多次,希望每次处理方式一致
- 结果要交给同事或上级复核,需要统一的结构和清楚的依据
- 新人接手这类工作,需要一个可以照着做的标准流程
反过来,如果只是偶尔做一次,或者任务高度依赖现场判断,直接和Git 仓库与代码托管平台里的智能体对话即可,不必专门封装成技能。
延伸阅读
- 分支清理 · Claude 应用中的 Skills 版
- 分支清理 · Cline Rules 版
- 分支清理 · LangChain / LangGraph 工具 版
- Issue 分诊 · SKILL.md 写法
- 长期未合并 PR 提醒 · SKILL.md 写法
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。