介绍
# Skill Creator
此技能为创建有效的技能提供指导。
## 关于技能
技能是模块化的、自包含的软件包,它们通过提供专业知识、工作流和工具来扩展 Claude 的能力。可以将它们视为特定领域或任务的“入职指南”——它们将 Claude 从通用型代理转变为具备程序化知识的专用型代理,而这种知识是任何模型都无法完全拥有的。
### 技能提供的内容
1. 专用工作流 - 针对特定领域的多步骤程序 2. 工具集成 - 使用特定文件格式或 API 的说明 3. 领域专业知识 - 特定于公司的知识、模式、业务逻辑 4. 捆绑资源 - 用于复杂和重复任务的脚本、参考资料和资产
## 核心原则
### 简洁是关键
上下文窗口是公共资源。技能与 Claude 需要的其他所有内容共享上下文窗口:系统提示词、对话历史、其他技能的元数据以及实际的用户请求。
**默认假设:Claude 已经非常聪明。** 仅添加 Claude 尚未具备的上下文。质疑每一条信息:“Claude 真的需要这个解释吗?”以及“这个段落是否值得花费这些 token?”
优先使用简洁的示例,而不是冗长的解释。
### 设定适当的自由度
将具体程度与任务的脆弱性和变异性相匹配:
**高自由度(基于文本的指令)**:当存在多种有效方法、决策取决于上下文、或启发式规则指导该方法时使用。
**中等自由度(带参数的伪代码或脚本)**:当存在首选模式、允许一些变体、或配置会影响行为时使用。
**低自由度(特定脚本,少量参数)**:当操作脆弱且容易出错、一致性至关重要、或必须遵循特定顺序时使用。
将 Claude 想象成在探索一条路径:悬崖上的狭窄桥梁需要特定的护栏(低自由度),而开阔的田野允许许多路线(高自由度)。
### 技能剖析
每个技能都包含一个必需的 SKILL.md 文件和可选的捆绑资源:
``` skill-name/ ├── SKILL.md (required) │ ├── YAML frontmatter metadata (required) │ │ ├── name: (required) │ │ └── description: (required) │ └── Markdown instructions (required) └── Bundled Resources (optional) ├── scripts/ - Executable code (Python/Bash/etc.) ├── references/ - Documentation intended to be loaded into context as needed └── assets/ - Files used in output (templates, icons, fonts, etc.) ```
#### SKILL.md(必需)
每个 SKILL.md 包含:
- **Frontmatter**(YAML):包含 `name` 和 `description` 字段。这些是 Claude 读取以确定何时使用该技能的唯一字段,因此清晰而全面地描述技能是什么以及何时应使用它至关重要。 - **Body**(Markdown):使用该技能的说明和指导。仅在技能触发后加载(如果有的话)。
#### 捆绑资源(可选)
##### 脚本(`scripts/`)
用于需要确定性可靠性或被反复重写任务的可执行代码(Python/Bash 等)。
- **何时包含**:当同一代码被反复重写或需要确定性可靠性时 - **示例**:用于 PDF 旋转任务的 `scripts/rotate_pdf.py` - **优势**:节省 token,具有确定性,可以在不加载到上下文的情况下执行 - **注意**:Claude 仍可能需要读取脚本以进行修补或特定于环境的调整
##### 参考资料(`references/`)
旨在根据需要加载到上下文中以告知 Claude 过程和思维的文档和参考资料。
- **何时包含**:对于 Claude 在工作时应参考的文档 - **示例**:用于财务模式的 `references/finance.md`、用于公司 NDA 模板的 `references/mnda.md`、用于公司政策的 `references/policies.md`、用于 API 规范的 `references/api_docs.md` - **用例**:数据库模式、API 文档、领域知识、公司政策、详细的工作流指南 - **优势**:保持 SKILL.md 精简,仅在 Claude 确定需要时加载 - **最佳实践**:如果文件很大(> 1 万字),请在 SKILL.md 中包含 grep 搜索模式 - **避免重复**:信息应存在于 SKILL.md 或参考资料文件中,而不能同时存在两者。对于详细信息,首选参考资料文件,除非它确实是该技能的核心——这使 SKILL.md 保持精简,同时使信息可被发现而不会占用上下文窗口。在 SKILL.md 中仅保留基本的过程说明和工作流指导;将详细的参考资料、模式和示例移至参考资料文件。
##### 资产(`assets/`)
不打算加载到上下文中,而是在 Claude 产生的输出中使用的文件。
- **何时包含**:当技能需要在最终输出中使用的文件时 - **示例**:用于品牌资产的 `assets/logo.png`、用于 PowerPoint 模板的 `assets/slides.pptx`、用于 HTML/React 样板的 `assets/frontend-template/`、用于排版的 `assets/font.ttf` - **用例**:模板、图像、图标、样板代码、字体、被复制或修改的示例文档 - **优势**:将输出资源与文档分离,使 Claude 能够在不加载文件的情况下使用它们
#### 技能中不应包含的内容
技能应仅包含直接支持其功能的基本文件。不要创建多余的文档或辅助文件,包括:
- README.md - INSTALLATION_GUIDE.md - QUICK_REFERENCE.md - CHANGELOG.md - 等等。
技能应仅包含 AI 代理完成手头工作所需的信息。它不应包含有关创建它的过程、设置和测试程序、面向用户的文档等的辅助上下文。仅创建额外的文档文件只会增加混乱和困惑。
### 渐进式呈现设计原则
技能使用三级加载系统来高效管理上下文:
1. **元数据(名称 + 描述)** - 始终在上下文中(约 100 字) 2. **SKILL.md body** - 当技能触发时(< 5k 字) 3. **捆绑资源** - 根据 Claude 的需要(无限,因为脚本可以在不读取到上下文窗口的情况下执行)
#### 渐进式呈现模式
将 SKILL.md body 保持在基本要素内并控制在 500 行以内,以最大限度地减少上下文膨胀。在接近此限制时,将内容拆分为单独的文件。将内容拆分到其他文件时,非常重要的一点是要在 SKILL.md 中引用它们,并清楚地说明何时阅读它们,以确保技能的读者知道它们的存在以及何时使用它们。
**关键原则:** 当技能支持多个变体、框架或选项时,仅将核心工作流和选择指导保留在 SKILL.md 中。将特定于变体的详细信息(模式、示例、配置)移至单独的参考资料文件。
**模式 1:带有参考资料的高级指南**
```markdown # PDF Processing
## Quick start
Extract text with pdfplumber: [code example]
## Advanced features
- **Form filling**: See [FORMS.md](FORMS.md) for complete guide - **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods - **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns ```
Claude 仅在需要时加载 FORMS.md、REFERENCE.md 或 EXAMPLES.md。
**模式 2:特定于领域的组织**
对于具有多个领域的技能,按领域组织内容以避免加载不相关的上下文:
``` bigquery-skill/ ├── SKILL.md (overview and navigation) └── reference/ ├── finance.md (revenue, billing metrics) ├── sales.md (opportunities, pipeline) ├── product.md (API usage, features) └── marketing.md (campaigns, attribution) ```
当用户询问销售指标时,Claude 仅读取 sales.md。
同样,对于支持多个框架或变体的技能,按变体组织:
``` cloud-deploy/ ├── SKILL.md (workflow + provider selection) └── references/ ├── aws.md (AWS deployment patterns) ├── gcp.md (GCP deployment patterns) └── azure.md (Azure deployment patterns) ```
当用户选择 AWS 时,Claude 仅读取 aws.md。
**模式 3:条件细节**
显示基本内容,链接到高级内容:
```markdown # DOCX Processing
## Creating documents
Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
## Editing documents
For simple edits, modify the XML directly.
**For tracked changes**: See [REDLINING.md](REDLINING.md) **For OOXML details**: See [OOXML.md](OOXML.md) ```
Claude 仅在用户需要这些功能时读取 REDLINING.md 或 OOXML.md。
**重要指南:**
- **避免深度嵌套的参考资料** - 保持参考资料离 SKILL.md 只有一层深度。所有参考资料文件都应直接从 SKILL.md 链接。 - **构建较长的参考资料文件** - 对于超过 100 行的文件,在顶部包含目录,以便 Claude 在预览时可以看到完整范围。
## 技能创建流程
技能创建涉及这些步骤:
1. 通过具体示例理解技能 2. 规划可重用的技能内容(脚本、参考资料、资产) 3. 初始化技能(运行 init_skill.py) 4. 编辑技能(实现资源并编写 SKILL.md) 5. 打包技能(运行 package_skill.py) 6. 根据实际使用进行迭代
按顺序遵循这些步骤,仅当有明确理由不适用时才跳过。
### 第 1 步:通过具体示例理解技能
仅当技能的使用模式已经清晰理解时,才跳过此步骤。即使在使用现有技能时,它仍然有价值。
要创建有效的技能,请清楚地了解如何使用该技能的具体示例。这种理解可以来自直接的用户示例,或经用户反馈验证的生成示例。
例如,在构建图像编辑器技能时,相关问题包括:
- “图像编辑器技能应该支持哪些功能?编辑、旋转,还有其他吗?” - “你能举一些如何使用这个技能的例子吗?” - “我可以想象用户会要求‘去掉这张图片的红眼’或‘旋转这张图片’。你能想象这个技能还有其他使用方式吗?” - “用户会说什么来触发这个技能?”
为了避免让用户不知所措,请避免在一条消息中问太多问题。从最重要的问题开始,并根据需要跟进以提高有效性。
当清楚地了解技能应支持的功能时,结束此步骤。
### 第 2 步:规划可重用的技能内容
要将具体示例转化为有效的技能,请通过以下方式分析每个示例:
1. 考虑如何从头开始执行该示例 2. 确定在反复执行这些工作流时,哪些脚本、参考资料和资产会有所帮助
示例:在构建 `pdf-editor` 技能以处理“帮我旋转这个 PDF”等查询时,分析显示:
1. 旋转 PDF 每次都需要重写相同的代码 2. `scripts/rotate_pdf.py` 脚本将有助于存储在技能中
示例:在设计 `frontend-webapp-builder` 技能以处理“为我构建一个待办事项应用程序”或“为我构建一个仪表板来跟踪我的步数”等查询时,分析显示:
1. 编写前端 Web 应用每次都需要相同的样板 HTML/React 2. 一个包含样板 HTML/React 项目文件的 `assets/hello-world/` 模板存储在技能中将会很有帮助
示例:当构建一个用于处理诸如“今天有多少用户登录?”等查询的 `big-query` 技能时,分析显示:
1. 查询 BigQuery 每次都需要重新发现表架构和关系 2. 一个记录表架构的 `references/schema.md` 文件存储在技能中将会很有帮助
为了确定技能的内容,分析每个具体示例以创建要包含的可重用资源列表:脚本、引用和资产。
### 第 3 步:初始化技能
此时,是时候真正创建技能了。
仅当正在开发的技能已存在,并且需要迭代或打包时,才跳过此步骤。在这种情况下,请继续下一步。
当从头开始创建新技能时,请始终运行 `init_skill.py` 脚本。该脚本可以方便地生成一个新的模板技能目录,其中自动包含技能所需的一切,从而使技能创建过程更加高效和可靠。
用法:
```bash scripts/init_skill.py <skill-name> --path <output-directory> ```
该脚本:
- 在指定路径创建技能目录 - 生成具有适当的 frontmatter 和 TODO 占位符的 SKILL.md 模板 - 创建示例资源目录:`scripts/`、`references/` 和 `assets/` - 在每个目录中添加可以自定义或删除的示例文件
初始化后,根据需要自定义或删除生成的 SKILL.md 和示例文件。
### 第 4 步:编辑技能
在编辑(新生成的或现有的)技能时,请记住该技能是为另一个 Claude 实例使用而创建的。包含对 Claude 有益且非显而易见的信息。考虑哪些程序性知识、领域特定细节或可重用资产将帮助另一个 Claude 实例更有效地执行这些任务。
#### 学习经过验证的设计模式
根据技能的需求查阅这些有用的指南:
- **多步骤流程**:请参阅 references/workflows.md 以了解顺序工作流和条件逻辑 - **特定输出格式或质量标准**:请参阅 references/output-patterns.md 以了解模板和示例模式
这些文件包含有效技能设计的既定最佳实践。
#### 从可重用的技能内容开始
要开始实施,请从上面确定的可重用资源开始:`scripts/`、`references/` 和 `assets/` 文件。请注意,此步骤可能需要用户输入。例如,在实施 `brand-guidelines` 技能时,用户可能需要提供品牌资产或模板以存储在 `assets/` 中,或需要存储在 `references/` 中的文档。
必须通过实际运行来测试添加的脚本,以确保没有错误并且输出符合预期。如果有许多类似的脚本,则只需测试具有代表性的样本,以确保确信它们都能工作,同时平衡完成时间。
应删除技能不需要的任何示例文件和目录。初始化脚本在 `scripts/`、`references/` 和 `assets/` 中创建示例文件以演示结构,但大多数技能并不需要所有这些文件。
#### 更新 SKILL.md
**编写指南:** 始终使用命令式/不定式形式。
##### Frontmatter
使用 `name` 和 `description` 编写 YAML frontmatter:
- `name`:技能名称 - `description`:这是技能的主要触发机制,有助于 Claude 了解何时使用该技能。 - 包括技能的功能以及使用它的特定触发器/上下文。 - 在此处包含所有“何时使用”信息 - 不要放在正文中。正文仅在触发后加载,因此正文中的“何时使用此技能”部分对 Claude 没有帮助。 - `docx` 技能的描述示例:“全面的文档创建、编辑和分析,支持跟踪更改、评论、格式保留和文本提取。当 Claude 需要处理专业文档(.docx 文件)时使用:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理跟踪更改,(4) 添加评论,或任何其他文档任务”
不要在 YAML frontmatter 中包含任何其他字段。
##### 正文
编写使用技能及其捆绑资源的说明。
### 第 5 步:打包技能
技能开发完成后,必须将其打包为可分发的 .skill 文件,并与用户共享。打包过程会自动首先验证技能,以确保其满足所有要求:
```bash scripts/package_skill.py <path/to/skill-folder> ```
可选的输出目录规范:
```bash scripts/package_skill.py <path/to/skill-folder> ./dist ```
打包脚本将:
1. **自动验证**技能,检查:
- YAML frontmatter 格式和必填字段 - 技能命名约定和目录结构 - 描述的完整性和质量 - 文件组织和资源引用
2. 如果验证通过,则**打包**技能,创建一个以技能命名的 .skill 文件(例如 `my-skill.skill`),其中包含所有文件并保持适当的目录结构以便分发。.skill 文件是一个带有 .skill 扩展名的 zip 文件。
如果验证失败,脚本将报告错误并退出,而不创建包。修复任何验证错误并再次运行打包命令。
### 第 6 步:迭代
测试技能后,用户可能会要求改进。这通常发生在使用技能后不久,并拥有有关技能表现的新鲜上下文。
**迭代工作流:**
1. 在实际任务中使用技能 2. 注意困难或低效之处 3. 确定应如何更新 SKILL.md 或捆绑资源 4. 实施更改并再次测试