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