--- name: skill-creator description: "创建有效技能的指南。当用户希望创建新技能(或更新现有技能)以扩展 Claude 的能力,包含专业知识、工作流程或工具集成时使用。当用户提到「创建技能」「写一个 skill」「skill 开发」「技能制作」时触发。" license: MIT --- # Skill Creator 本技能提供创建有效技能的指导。 --- ## 关于 Skills Skills 是模块化、自包含的包,通过提供专业知识、工作流程和工具来扩展 Claude 的能力。可将它们视为特定领域或任务的「入门指南」——它们将 Claude 从通用智能体转变为具备程序性知识的专业智能体,这些知识是任何模型都无法完全掌握的。 ### Skills 提供什么 1. **专业工作流程** - 特定领域的多步骤程序 2. **工具集成** - 处理特定文件格式或 API 的说明 3. **领域专业知识** - 公司特定知识、模式、业务逻辑 4. **打包资源** - 用于复杂和重复任务的脚本、参考资料和资源 --- ## 核心原则 ### 简洁是关键 上下文窗口是公共资源。Skills 与 Claude 所需的其他内容共享上下文窗口:系统提示、对话历史、其他 Skills 的元数据,以及实际用户请求。 **默认假设:Claude 已经非常聪明。** 只添加 Claude 尚未拥有的上下文。质疑每条信息:「Claude 真的需要这个解释吗?」和「这段文字是否值得它的 token 成本?」 优先使用简洁示例而非冗长解释。 ### 设置适当的自由度 将特异性级别与任务的脆弱性和可变性匹配: - **高自由度(基于文本的说明)**:当多种方法有效、决策取决于上下文,或启发式指导方法时使用。 - **中等自由度(带参数的伪代码或脚本)**:当存在首选模式、允许一些变化,或配置影响行为时使用。 - **低自由度(特定脚本,参数少)**:当操作脆弱且容易出错、一致性至关重要,或必须遵循特定序列时使用。 将 Claude 视为探索路径:有悬崖的窄桥需要特定的护栏(低自由度),而开阔的田野允许多条路线(高自由度)。 --- ## Skill 的构成 每个 skill 包含必需的 SKILL.md 文件和可选的打包资源: ``` skill-name/ ├── SKILL.md (必需) │ ├── YAML frontmatter 元数据 (必需) │ │ ├── name: (必需) │ │ └── description: (必需) │ └── Markdown 说明 (必需) └── 打包资源 (可选) ├── scripts/ - 可执行代码 (Python/Bash 等) ├── references/ - 按需加载到上下文的文档 └── assets/ - 输出中使用的文件 (模板、图标、字体等) ``` ### SKILL.md (必需) 每个 SKILL.md 包含: - **Frontmatter** (YAML):包含 `name` 和 `description` 字段。这些是 Claude 用来确定何时使用该技能的唯一字段,因此清晰全面地描述技能是什么以及何时使用非常重要。 - **Body** (Markdown):使用技能的说明和指导。仅在技能触发后加载(如果需要)。 ### 打包资源 (可选) #### Scripts (`scripts/`) 需要确定性可靠性或重复编写的任务的可执行代码(Python/Bash 等)。 - **何时包含**:当相同代码被重复编写或需要确定性可靠性时 - **示例**:`scripts/rotate_pdf.py` 用于 PDF 旋转任务 - **优势**:Token 高效、确定性、可在不加载到上下文的情况下执行 - **注意**:脚本可能仍需要被 Claude 读取以进行补丁或环境特定调整 #### References (`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 或 references 文件中,而不是两者。除非信息真正是技能的核心,否则优先使用 references 文件存储详细信息——这保持 SKILL.md 精简,同时使信息可发现而不占用上下文窗口。在 SKILL.md 中仅保留基本程序说明和工作流程指导;将详细参考资料、模式和示例移至 references 文件。 #### Assets (`assets/`) 不打算加载到上下文中的文件,而是在 Claude 产生的输出中使用。 - **何时包含**:当技能需要将在最终输出中使用的文件时 - **示例**:`assets/logo.png` 用于品牌资源,`assets/slides.pptx` 用于 PowerPoint 模板,`assets/frontend-template/` 用于 HTML/React 样板,`assets/font.ttf` 用于排版 - **用例**:模板、图像、图标、样板代码、字体、被复制或修改的示例文档 - **优势**:将输出资源与文档分离,使 Claude 能够使用文件而不将其加载到上下文中 ### 不应包含在 Skill 中的内容 Skill 应仅包含直接支持其功能的必需文件。**不要**创建多余的文档或辅助文件,包括: - README.md - INSTALLATION_GUIDE.md - QUICK_REFERENCE.md - CHANGELOG.md - 等等 Skill 应仅包含 AI 智能体完成手头工作所需的信息。它不应包含关于创建它的过程的辅助上下文、设置和测试程序、面向用户的文档等。创建额外的文档文件只会增加混乱和困惑。 --- ## 渐进式披露设计原则 Skills 使用三级加载系统来高效管理上下文: 1. **元数据(name + description)** - 始终在上下文中(~100 词) 2. **SKILL.md body** - 技能触发时(<5k 词) 3. **打包资源** - 按 Claude 需要(无限,因为脚本可以在不读取到上下文窗口的情况下执行) ### 渐进式披露模式 保持 SKILL.md body 精简,控制在 500 行以内,以最小化上下文膨胀。接近此限制时,将内容拆分为单独文件。将内容拆分到其他文件时,从 SKILL.md 引用它们并清楚描述何时读取它们非常重要,以确保技能读者知道它们存在以及何时使用它们。 **关键原则**:当技能支持多种变体、框架或选项时,在 SKILL.md 中仅保留核心工作流程和选择指导。将变体特定细节(模式、示例、配置)移至单独的参考文件。 **模式 1:高级指南与参考资料** ```markdown # PDF 处理 ## 快速开始 使用 pdfplumber 提取文本: [代码示例] ## 高级功能 - **表单填写**:参见 [FORMS.md](FORMS.md) 获取完整指南 - **API 参考**:参见 [REFERENCE.md](REFERENCE.md) 获取所有方法 - **示例**:参见 [EXAMPLES.md](EXAMPLES.md) 获取常见模式 ``` Claude 仅在需要时加载 FORMS.md、REFERENCE.md 或 EXAMPLES.md。 **模式 2:领域特定组织** 对于具有多个领域的 Skills,按领域组织内容以避免加载无关上下文: ``` bigquery-skill/ ├── SKILL.md (概述和导航) └── reference/ ├── finance.md (收入、计费指标) ├── sales.md (机会、管道) ├── product.md (API 使用、功能) └── marketing.md (活动、归因) ``` 当用户询问销售指标时,Claude 仅读取 sales.md。 类似地,对于支持多个框架或变体的技能,按变体组织: ``` cloud-deploy/ ├── SKILL.md (工作流程 + 提供商选择) └── references/ ├── aws.md (AWS 部署模式) ├── gcp.md (GCP 部署模式) └── azure.md (Azure 部署模式) ``` 当用户选择 AWS 时,Claude 仅读取 aws.md。 **模式 3:条件细节** 显示基本内容,链接到高级内容: ```markdown # DOCX 处理 ## 创建文档 使用 docx-js 创建新文档。参见 [DOCX-JS.md](DOCX-JS.md)。 ## 编辑文档 对于简单编辑,直接修改 XML。 **对于跟踪更改**:参见 [REDLINING.md](REDLINING.md) **对于 OOXML 详细信息**:参见 [OOXML.md](OOXML.md) ``` Claude 仅在用户需要这些功能时读取 REDLINING.md 或 OOXML.md。 **重要指南:** - **避免深度嵌套引用** - 保持引用从 SKILL.md 一级深度。所有参考文件应从 SKILL.md 直接链接。 - **构建更长的参考文件** - 对于超过 100 行的文件,在顶部包含目录,以便 Claude 在预览时可以看到完整范围。 --- ## Skill 创建流程 Skill 创建涉及以下步骤: 1. 通过具体示例理解技能 2. 规划可重用技能内容(脚本、参考资料、资源) 3. 初始化技能(运行 init_skill.py) 4. 编辑技能(实现资源并编写 SKILL.md) 5. 打包技能(运行 package_skill.py) 6. 基于实际使用迭代 按顺序执行这些步骤,仅在明确不适用时才跳过。 ### 步骤 1:通过具体示例理解技能 仅在技能的使用模式已经清楚理解时才跳过此步骤。即使在使用现有技能时,它仍然有价值。 要创建有效的技能,清楚地理解技能将如何使用的具体示例。这种理解可以来自直接用户示例或经过用户反馈验证的生成示例。 例如,在构建图像编辑器技能时,相关问题包括: - 「图像编辑器技能应支持什么功能?编辑、旋转,还有其他吗?」 - 「你能给出一些如何使用此技能的示例吗?」 - 「我可以想象用户会要求诸如『从这张图像中移除红眼』或『旋转这张图像』之类的事情。你还能想象此技能的其他使用方式吗?」 - 「用户说什么应该触发此技能?」 为避免让用户不知所措,避免在单条消息中问太多问题。从最重要的问题开始,根据需要跟进以提高有效性。 当对技能应支持的功能有清晰理解时,结束此步骤。 ### 步骤 2:规划可重用技能内容 要将具体示例转化为有效技能,通过以下方式分析每个示例: 1. 考虑如何从头开始执行示例 2. 识别在执行这些工作流程时会有帮助的脚本、参考资料和资源 **示例**:在构建处理「帮我旋转这个 PDF」等查询的 `pdf-editor` 技能时,分析显示: 1. 旋转 PDF 每次都需要重写相同代码 2. 在技能中存储 `scripts/rotate_pdf.py` 脚本会很有帮助 **示例**:在设计处理「给我构建一个待办事项应用」或「给我构建一个跟踪步数的仪表板」等查询的 `frontend-webapp-builder` 技能时,分析显示: 1. 编写前端 webapp 每次都需要相同的样板 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 --path ``` 该脚本: - 在指定路径创建技能目录 - 生成带有适当 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 理解何时使用技能。 - 包含技能做什么以及何时使用它的特定触发器/上下文。 - 在此处包含所有「何时使用」信息 - 不要在 body 中。body 仅在触发后加载,因此 body 中的「何时使用此技能」部分对 Claude 没有帮助。 - `docx` 技能的描述示例:「全面的文档创建、编辑和分析,支持跟踪更改、评论、格式保留和文本提取。当 Claude 需要处理专业文档(.docx 文件)时使用:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理跟踪更改,(4) 添加评论,或任何其他文档任务」 不要在 YAML frontmatter 中包含任何其他字段。 ##### Body 编写使用技能及其打包资源的说明。 ### 步骤 5:打包技能 技能开发完成后,必须将其打包到可分发的 .skill 文件中,与用户共享。打包过程首先自动验证技能以确保它满足所有要求: ```bash scripts/package_skill.py ``` 可选输出目录规范: ```bash scripts/package_skill.py ./dist ``` 打包脚本将: 1. **验证**技能自动,检查: - YAML frontmatter 格式和必需字段 - 技能命名约定和目录结构 - 描述完整性和质量 - 文件组织和资源引用 2. **打包**技能(如果验证通过),创建以技能命名的 .skill 文件(例如,`my-skill.skill`),包含所有文件并保持适当的分发目录结构。.skill 文件是带有 .skill 扩展名的 zip 文件。 如果验证失败,脚本将报告错误并退出而不创建包。修复任何验证错误并再次运行打包命令。 ### 步骤 6:迭代 测试技能后,用户可能会请求改进。这通常在使用技能后立即发生,对技能的表现有新的上下文。 **迭代工作流程:** 1. 在实际任务上使用技能 2. 注意困难或低效 3. 确定应如何更新 SKILL.md 或打包资源 4. 实施更改并再次测试 --- ## 检查清单 创建技能时,确保: - [ ] Frontmatter 包含 `name` 和 `description` - [ ] `description` 清晰说明技能做什么以及何时使用 - [ ] SKILL.md body 简洁(<500 行) - [ ] 可重用资源(scripts、references、assets)已识别并实现 - [ ] 脚本已测试并正常工作 - [ ] 参考资料按需引用,避免重复 - [ ] 技能已通过 package_skill.py 验证 - [ ] 技能在实际使用中测试