把「组件文档编写」交给智能体，难点不在模型能力，而在流程是否说清楚：输入是什么（组件代码），按什么顺序处理，交付什么（示例文件），哪些事不能做。Skill 就是把这些写下来的载体。

本文以「组件文档编写」为例，逐段讲解 SKILL.md 的写法。SKILL.md 是 Claude Agent Skills 采用的格式：YAML 头 + Markdown 正文，其结构思路也适用于其他平台的规则文件与指令。

完整示例

---
name: storybook-writer
description: 为组件编写 Storybook 示例与说明。当用户提到组件文档编写、或给出组件代码并希望得到示例文件时使用。
---

# 组件文档编写

## 输入
- 组件代码
- 若缺少关键信息，先列出需要补充的问题

## 步骤
1. 列出组件状态
2. 为每个状态写示例
3. 补充参数说明
4. 检查渲染

## 输出
- 示例文件
- 末尾附「需人工确认」清单（没有则写“无”）

## 约束
- 视觉与交互结果要在真实浏览器里确认。
- 信息不足时先提问，不要自行编造数据或事实。

第一段：name

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

第二段：description（最关键）

智能体平时只看得到 description，靠它判断要不要加载技能。好的 description 同时回答两件事：做什么（为组件编写 Storybook 示例与说明），什么时候用（用户提到组件文档编写或给出组件代码时）。

反例：“一个很有用的组件文档编写工具”——没有触发条件，智能体很难对上号。

第三段：输入与步骤

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

  1. 列出组件状态
  2. 为每个状态写示例
  3. 补充参数说明
  4. 检查渲染

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

第四段：输出

写明交付物（示例文件）以及固定结构。建议统一附上“需人工确认”清单，让复核的人知道看哪里。

第五段：约束

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

  • 视觉与交互结果要在真实浏览器里确认。
  • 信息不足时先提问，不要自行编造数据或事实。

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

团队规范、长模板、术语表不要塞进 SKILL.md 正文，放到同目录的 reference.md 等文件中，在正文里写“需要时阅读 reference.md”。这样平时加载很轻，需要时再读取细节。

目录结构

.claude/skills/storybook-writer/
├── SKILL.md
└── reference.md      # 可选：团队规范、模板等长资料，按需加载

写完之后

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

平台选择建议

同一个「组件文档编写」技能可以落在不同平台上，选择时主要看你在哪里工作、要不要执行代码、要不要接外部系统：

  • Cline Rules：Cline 支持在项目中用 .clinerules 写规则（可以是单个文件。详见Cline Rules 版
  • LangChain / LangGraph 工具：LangChain 用 @tool 装饰器把函数变成工具。详见LangChain / LangGraph 工具 版
  • Claude Code Skill：Claude Code 的 Agent Skills 以文件夹为单位：一个 SKILL.md（YAML 头写 name 与 description）加上可选的脚本和参考资料。智能体平时只看到 description。详见Claude Code Skill 版

这个技能纯指令型，不需要额外脚本或外部连接，复制到大多数平台都能用，可据此排除不支持相应能力的平台。

延伸阅读

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