name: 技能开发 description: 此技能应用于用户想要“创建技能”、“向插件添加技能”、“编写新技能”、“改进技能描述”、“组织技能内容”时,或需要有关技能结构、渐进式披露或Claude代码插件技能开发最佳实践的指导。 version: 0.1.0
Claude代码插件技能开发
此技能提供创建Claude代码插件有效技能的指导。
关于技能
技能是模块化、自包含的包,通过提供专业知识、工作流程和工具来扩展Claude的能力。将它们视为特定领域或任务的“入门指南”—它们将Claude从通用代理转变为配备程序性知识的专业代理,而这是任何模型都无法完全掌握的。
技能提供的内容
- 专业化工作流程 - 特定领域的多步程序
- 工具集成 - 使用特定文件格式或API的指令
- 领域专业知识 - 公司特定知识、模式、业务逻辑
- 捆绑资源 - 用于复杂和重复任务的脚本、参考和资产
技能的组成
每个技能包含一个必需的SKILL.md文件和可选的捆绑资源:
技能名称/
├── SKILL.md (必需)
│ ├── YAML前置元数据 (必需)
│ │ ├── name: (必需)
│ │ └── description: (必需)
│ └── Markdown指令 (必需)
└── 捆绑资源 (可选)
├── scripts/ - 可执行代码 (Python/Bash等)
├── references/ - 文档,根据需要加载到上下文中
└── assets/ - 输出中使用的文件 (模板、图标、字体等)
SKILL.md (必需)
元数据质量: YAML前置元数据中的name和description决定Claude何时使用该技能。具体说明技能的作用和使用时机。使用第三人称(例如,“此技能应用于…”而不是“使用此技能…”)。
捆绑资源 (可选)
脚本 (scripts/)
用于需要确定性可靠性或重复重写任务的可执行代码(Python/Bash等)。
- 何时包含: 当相同代码重复重写或需要确定性可靠性时
- 示例:
scripts/rotate_pdf.py用于PDF旋转任务 - 好处: 令牌高效、确定性,无需加载到上下文即可执行
- 注意: 脚本可能仍需要被Claude读取以进行修补或环境特定调整
参考 (references/)
文档和参考材料,旨在根据需要加载到上下文中,以告知Claude的过程和思考。
- 何时包含: 用于Claude在工作时应参考的文档
- 示例:
references/finance.md用于财务模式,references/mnda.md用于公司NDA模板,references/policies.md用于公司政策,references/api_docs.md用于API规范 - 用例: 数据库模式、API文档、领域知识、公司政策、详细工作流程指南
- 好处: 保持SKILL.md精简,仅在Claude确定需要时加载
- 最佳实践: 如果文件较大(>10k字),在SKILL.md中包含grep搜索模式
- 避免重复: 信息应位于SKILL.md或参考文件中,而不是两者都有。偏好参考文件用于详细信息,除非它确实是技能的核心—这保持SKILL.md精简,同时使信息可发现而不占用上下文窗口。仅将基本程序性指令和工作流程指导保留在SKILL.md中;将详细参考材料、模式和示例移至参考文件。
资产 (assets/)
不旨在加载到上下文中的文件,而是在Claude产生的输出中使用。
- 何时包含: 当技能需要将在最终输出中使用的文件时
- 示例:
assets/logo.png用于品牌资产,assets/slides.pptx用于PowerPoint模板,assets/frontend-template/用于HTML/React样板,assets/font.ttf用于排版 - 用例: 模板、图像、图标、样板代码、字体、被复制或修改的样本文档
- 好处: 将输出资源与文档分离,使Claude能够使用文件而不加载到上下文中
渐进式披露设计原则
技能使用三级加载系统以高效管理上下文:
- 元数据(名称 + 描述) - 始终在上下文中(约100字)
- SKILL.md主体 - 当技能触发时(<5k字)
- 捆绑资源 - 根据Claude需要(无限*)
*无限是因为脚本无需读取到上下文窗口即可执行。
技能创建流程
要创建技能,按顺序遵循“技能创建流程”,仅当有明显原因不适用时才跳过步骤。
步骤1:通过具体示例理解技能
仅当技能的使用模式已清晰理解时才跳过此步骤。即使处理现有技能,此步骤仍有价值。
要创建有效技能,清晰地理解技能将如何使用的具体示例。此理解可来自直接用户示例或生成并通过用户反馈验证的示例。
例如,构建图像编辑器技能时,相关问题包括:
- “图像编辑器技能应支持哪些功能?编辑、旋转,还有其他吗?”
- “你能给出此技能将如何使用的一些示例吗?”
- “我可以想象用户请求‘从此图像中移除红眼’或‘旋转此图像’。你想象此技能以其他方式使用吗?”
- “用户说什么应触发此技能?”
为避免使用户不知所措,避免在单个消息中问太多问题。从最重要的问题开始,并根据需要跟进以更好效果。
当对技能应支持的功能有清晰理解时,结束此步骤。
步骤2:规划可重用技能内容
要将具体示例转化为有效技能,分析每个示例:
- 考虑如何从头执行示例
- 识别在执行这些工作流程重复时,哪些脚本、参考和资产会有帮助
示例:构建pdf-editor技能以处理查询如“帮助我旋转此PDF”时,分析显示:
- 旋转PDF每次需要重写相同代码
scripts/rotate_pdf.py脚本存储于技能中会有帮助
示例:设计frontend-webapp-builder技能以处理查询如“构建我待办事项应用”或“构建我跟踪步骤的仪表板”时,分析显示:
- 编写前端webapp每次需要相同样板HTML/React
assets/hello-world/模板包含样板HTML/React项目文件存储于技能中会有帮助
示例:构建big-query技能以处理查询如“今天有多少用户登录?”时,分析显示:
- 查询BigQuery每次需要重新发现表模式和关系
references/schema.md文件记录表模式会有帮助
对于Claude代码插件: 构建钩子技能时,分析显示:
- 开发人员重复需要验证hooks.json和测试钩子脚本
scripts/validate-hook-schema.sh和scripts/test-hook.sh实用程序会有帮助references/patterns.md用于详细钩子模式以避免膨胀SKILL.md
为建立技能内容,分析每个具体示例以创建要包含的可重用资源列表:脚本、参考和资产。
步骤3:创建技能结构
对于Claude代码插件,创建技能目录结构:
mkdir -p 插件名称/skills/技能名称/{references,examples,scripts}
touch 插件名称/skills/技能名称/SKILL.md
注意: 与通用技能创建器使用init_skill.py不同,插件技能直接在插件的skills/目录中以更简单的手动结构创建。
步骤4:编辑技能
编辑(新创建或现有)技能时,记住技能是为另一个Claude实例使用而创建的。专注于包含对Claude有益且非显而易见的信息。考虑哪些程序性知识、领域特定细节或可重用资产将帮助另一个Claude实例更有效地执行这些任务。
从可重用技能内容开始
要开始实施,从上述识别的可重用资源开始:scripts/、references/和assets/文件。注意此步骤可能需要用户输入。例如,实施brand-guidelines技能时,用户可能需要提供品牌资产或模板存储在assets/中,或文档存储在references/中。
同时,删除技能不需要的任何示例文件和目录。仅创建实际需要的目录(references/, examples/, scripts/)。
更新SKILL.md
写作风格: 使用命令式/不定式形式(动词优先指令)编写整个技能,而非第二人称。使用客观、指导性语言(例如,“要完成X,做Y”而不是“你应做X”或“如果你需要做X”)。这保持AI消费的一致性和清晰度。
描述(前置元数据): 使用第三人称格式和特定触发短语:
---
name: 技能名称
description: 此技能应用于用户要求“特定短语1”、“特定短语2”、“特定短语3”时。包括用户会说以触发此技能的确切短语。具体而明确。
version: 0.1.0
---
良好描述示例:
description: 此技能应用于用户要求“创建钩子”、“添加PreToolUse钩子”、“验证工具使用”、“实施基于提示的钩子”或提及钩子事件(PreToolUse、PostToolUse、Stop)时。
不良描述示例:
description: 使用此技能处理钩子时。 # 错误人称,模糊
description: 当用户需要钩子帮助时加载。 # 非第三人称
description: 提供钩子指导。 # 无触发短语
要完成SKILL.md主体,回答以下问题:
- 技能的目的是什么,用几句话?
- 何时应使用技能?(包括在前置元数据描述中,使用特定触发)
- 在实践中,Claude应如何使用技能?所有上述开发的可重用技能内容应被引用,以便Claude知道如何使用它们。
保持SKILL.md精简: 目标主体1,500-2,000字。将详细内容移至references/:
- 详细模式 →
references/patterns.md - 高级技术 →
references/advanced.md - 迁移指南 →
references/migration.md - API参考 →
references/api-reference.md
在SKILL.md中引用资源:
## 附加资源
### 参考文件
详细模式和技术的咨询:
- **`references/patterns.md`** - 常见模式
- **`references/advanced.md`** - 高级用例
### 示例文件
`examples/`中的工作示例:
- **`example-script.sh`** - 工作示例
步骤5:验证和测试
对于插件技能,验证与通用技能不同:
- 检查结构: 技能目录在
插件名称/skills/技能名称/中 - 验证SKILL.md: 具有名称和描述的前置元数据
- 检查触发短语: 描述包括特定用户查询
- 验证写作风格: 主体使用命令式/不定式形式,非第二人称
- 测试渐进式披露: SKILL.md精简(约1,500-2,000字),详细内容在references/
- 检查参考: 所有引用文件存在
- 验证示例: 示例完整且正确
- 测试脚本: 脚本可执行且工作正确
使用技能审查代理:
问:“审查我的技能并检查是否遵循最佳实践”
技能审查代理将检查描述质量、内容组织和渐进式披露。
步骤6:迭代
测试技能后,用户可能请求改进。这通常在技能使用后立即发生,带有技能如何执行的新鲜上下文。
迭代工作流程:
- 在真实任务上使用技能
- 注意困难或低效
- 识别如何更新SKILL.md或捆绑资源
- 实施更改并再次测试
常见改进:
- 加强描述中的触发短语
- 将长节从SKILL.md移至references/
- 添加缺失示例或脚本
- 澄清模糊指令
- 添加边缘情况处理
插件特定考虑
插件中的技能位置
插件技能位于插件的skills/目录中:
我的插件/
├── .claude-plugin/
│ └── plugin.json
├── commands/
├── agents/
└── skills/
└── 我的技能/
├── SKILL.md
├── references/
├── examples/
└── scripts/
自动发现
Claude代码自动发现技能:
- 扫描
skills/目录 - 找到包含
SKILL.md的子目录 - 始终加载技能元数据(名称 + 描述)
- 当技能触发时加载SKILL.md主体
- 根据需要加载参考/示例
无需打包
插件技能作为插件的一部分分发,非单独ZIP文件。用户安装插件时获得技能。
插件中的测试
通过本地安装插件测试技能:
# 使用--plugin-dir测试
cc --plugin-dir /path/to/插件
# 问应触发技能的问题
# 验证技能正确加载
Plugin-Dev中的示例
研究此插件中的技能作为最佳实践示例:
hook-development技能:
- 优秀触发短语:“创建钩子”、“添加PreToolUse钩子”等
- 精简SKILL.md(1,651字)
- 3个references/文件用于详细内容
- 3个examples/工作钩子
- 3个scripts/实用程序
agent-development技能:
- 强触发:“创建代理”、“代理前置元数据”等
- 专注SKILL.md(1,438字)
- 参考包括Claude Code的AI生成提示
- 完整代理示例
plugin-settings技能:
- 特定触发:“插件设置”、“.local.md文件”、“YAML前置元数据”
- 参考显示真实实施(multi-agent-swarm、ralph-wiggum)
- 工作解析脚本
每个演示渐进式披露和强触发。
实践中的渐进式披露
SKILL.md中放什么
包括(技能触发时始终加载):
- 核心概念和概述
- 基本程序和流程
- 快速参考表
- 指向参考/示例/脚本的指针
- 最常见用例
保持在3,000字以下,理想1,500-2,000字
references/中放什么
移至references/(根据需要加载):
- 详细模式和高级技术
- 全面API文档
- 迁移指南
- 边缘情况和故障排除
- 广泛示例和演练
每个参考文件可大(2,000-5,000+字)
examples/中放什么
工作代码示例:
- 完整、可运行脚本
- 配置文件
- 模板文件
- 真实世界使用示例
用户可直接复制和适应这些
scripts/中放什么
实用脚本:
- 验证工具
- 测试助手
- 解析实用程序
- 自动化脚本
应可执行且有文档
写作风格要求
命令式/不定式形式
使用动词优先指令编写,非第二人称:
正确(命令式):
要创建钩子,定义事件类型。
配置MCP服务器与认证。
使用前验证设置。
不正确(第二人称):
你应通过定义事件类型创建钩子。
你需要配置MCP服务器。
你必须在使用前验证设置。
描述中的第三人称
前置元数据描述必须使用第三人称:
正确:
description: 此技能应用于用户要求“创建X”、“配置Y”...
不正确:
description: 使用此技能当你想要创建X...
description: 用户要求时加载此技能...
客观、指导性语言
专注于做什么,而非谁应做:
正确:
使用sed解析前置元数据。
使用grep提取字段。
使用前验证值。
不正确:
你可以解析前置元数据...
Claude应提取字段...
用户可能验证值...
验证清单
技能最终化前:
结构:
- [ ] SKILL.md文件存在具有有效YAML前置元数据
- [ ] 前置元数据有
name和description字段 - [ ] Markdown主体存在且实质
- [ ] 引用文件实际存在
描述质量:
- [ ] 使用第三人称(“此技能应用于…”)
- [ ] 包括用户会说的特定触发短语
- [ ] 列出具体场景(“创建X”、“配置Y”)
- [ ] 非模糊或通用
内容质量:
- [ ] SKILL.md主体使用命令式/不定式形式
- [ ] 主体专注且精简(理想1,500-2,000字,最大<5k)
- [ ] 详细内容移至references/
- [ ] 示例完整且工作
- [ ] 脚本可执行且有文档
渐进式披露:
- [ ] SKILL.md中的核心概念
- [ ] 详细文档在references/
- [ ] 工作代码在examples/
- [ ] 实用程序在scripts/
- [ ] SKILL.md引用这些资源
测试:
- [ ] 技能在预期用户查询上触发
- [ ] 内容对目标任务有帮助
- [ ] 跨文件无重复信息
- [ ] 根据需要加载参考
常见错误避免
错误1:弱触发描述
❌ 不良:
description: 提供钩子工作指导。
为何不良: 模糊、无特定触发短语、非第三人称
✅ 良好:
description: 此技能应用于用户要求“创建钩子”、“添加PreToolUse钩子”、“验证工具使用”或提及钩子事件时。提供全面钩子API指导。
为何良好: 第三人称、特定短语、具体场景
错误2:SKILL.md中太多内容
❌ 不良:
技能名称/
└── SKILL.md (8,000字 - 所有内容在一个文件中)
为何不良: 技能加载时膨胀上下文,详细内容始终加载
✅ 良好:
技能名称/
├── SKILL.md (1,800字 - 核心要点)
└── references/
├── patterns.md (2,500字)
└── advanced.md (3,700字)
为何良好: 渐进式披露,详细内容仅在需要时加载
错误3:第二人称写作
❌ 不良:
你应首先阅读配置文件。
你需要验证输入。
你可以使用grep工具搜索。
为何不良: 第二人称,非命令式形式
✅ 良好:
首先阅读配置文件。
处理前验证输入。
使用grep工具搜索模式。
为何良好: 命令式形式,直接指令
错误4:缺失资源引用
❌ 不良:
# SKILL.md
[核心内容]
[未提及references/或examples/]
为何不良: Claude不知道参考存在
✅ 良好:
# SKILL.md
[核心内容]
## 附加资源
### 参考文件
- **`references/patterns.md`** - 详细模式
- **`references/advanced.md`** - 高级技术
### 示例
- **`examples/script.sh`** - 工作示例
为何良好: Claude知道在哪里找到额外信息
快速参考
最小技能
技能名称/
└── SKILL.md
良好:简单知识,无需复杂资源
标准技能(推荐)
技能名称/
├── SKILL.md
├── references/
│ └── detailed-guide.md
└── examples/
└── working-example.sh
良好:大多数插件技能具有详细文档
完整技能
技能名称/
├── SKILL.md
├── references/
│ ├── patterns.md
│ └── advanced.md
├── examples/
│ ├── example1.sh
│ └── example2.json
└── scripts/
└── validate.sh
良好:复杂领域具有验证实用程序
最佳实践总结
✅ 做:
- 在描述中使用第三人称(“此技能应用于…”)
- 包括特定触发短语(“创建X”、“配置Y”)
- 保持SKILL.md精简(1,500-2,000字)
- 使用渐进式披露(将细节移至references/)
- 以命令式/不定式形式编写
- 清晰引用支持文件
- 提供工作示例
- 创建用于常见操作的实用脚本
- 研究plugin-dev的技能作为模板
❌ 不做:
- 在任何地方使用第二人称
- 有模糊触发条件
- 将所有内容放入SKILL.md(>3,000字无references/)
- 以第二人称编写(“你应…”)
- 留下资源未引用
- 包括损坏或不完整示例
- 跳过验证
附加资源
研究这些技能
Plugin-dev的技能演示最佳实践:
../hook-development/- 渐进式披露、实用程序../agent-development/- AI辅助创建、参考../mcp-integration/- 全面参考../plugin-settings/- 真实世界示例../command-development/- 清晰核心概念../plugin-structure/- 良好组织
参考文件
完整技能创建器方法学:
references/skill-creator-original.md- 完整原始技能创建器内容
实施工作流程
为插件创建技能:
- 理解用例: 识别技能使用的具体示例
- 规划资源: 确定需要哪些脚本/参考/示例
- 创建结构:
mkdir -p skills/技能名称/{references,examples,scripts} - 编写SKILL.md:
- 具有第三人称描述和触发短语的前置元数据
- 精简主体(1,500-2,000字)以命令式形式
- 引用支持文件
- 添加资源: 根据需要创建references/、examples/、scripts/
- 验证: 检查描述、写作风格、组织
- 测试: 验证技能在预期触发上加载
- 迭代: 基于使用改进
专注于强触发描述、渐进式披露和命令式写作风格,以创建在需要时加载并提供针对性指导的有效技能。