skill-creator
技能创建者
此技能提供创建有效技能的指导。
关于技能
技能是模块化、自包含的包,通过提供专业知识、工作流程和工具来扩展Claude的能力。将它们视为特定领域或任务的"入职指南"——它们将Claude从通用代理转变为配备程序知识的专业代理,而没有任何模型能够完全拥有这些知识。
技能提供的内容
- 专业工作流程 - 特定领域的多步程序
- 工具集成 - 使用特定文件格式或API的说明
- 领域专业知识 - 公司特定知识、架构、业务逻辑
- 捆绑资源 - 用于复杂和重复任务的脚本、参考资料和资产
核心原则
简洁是关键
上下文窗口是公共资源。技能与Claude需要的其他所有内容共享上下文窗口:系统提示、对话历史、其他技能的元数据以及实际用户请求。
默认假设:Claude已经非常聪明。 只添加Claude尚未拥有的上下文。挑战每条信息:"Claude真的需要这个解释吗?"和"这个段落是否值得其token成本?"
优先使用简洁的示例而非冗长的解释。
设置适当的自由度
将具体程度与任务的脆弱性和可变性相匹配:
高自由度(基于文本的说明):当多种方法有效、决策取决于上下文或启发式方法指导方法时使用。
中等自由度(带参数的伪代码或脚本):当存在首选模式、某些变化可接受或配置影响行为时使用。
低自由度(特定脚本、少量参数):当操作脆弱且容易出错、一致性至关重要或必须遵循特定序列时使用。
将Claude视为探索路径:悬崖上的狭窄桥梁需要特定的护栏(低自由度),而开阔的田野允许多条路线(高自由度)。
技能的解剖结构
每个技能由必需的SKILL.md文件和可选的捆绑资源组成:
skill-name/
├── SKILL.md (必需)
│ ├── YAML frontmatter元数据 (必需)
│ │ ├── name: (必需)
│ │ ├── description: (必需)
│ │ └── compatibility: (可选,很少需要)
│ └── Markdown说明 (必需)
└── 捆绑资源 (可选)
├── scripts/ - 可执行代码 (Python/Bash等)
├── references/ - 意图根据需要加载到上下文中的文档
└── assets/ - 输出中使用的文件 (模板、图标、字体等)
SKILL.md (必需)
每个SKILL.md由以下组成:
- Frontmatter (YAML):包含
name和description字段(必需),以及可选字段如license、metadata和compatibility。只有name和description被Claude读取以确定技能何时触发,因此要清楚全面地说明技能是什么以及何时应该使用它。compatibility字段用于记录环境要求(目标产品、系统包等),但大多数技能不需要它。 - 正文 (Markdown):使用技能及其捆绑资源的说明和指导。仅在技能触发后加载(如果有的话)。
捆绑资源 (可选)
脚本 (scripts/)
可执行代码(Python/Bash等),用于需要确定性可靠性或重复重写的任务。
- 何时包含:当同一代码被重复重写或需要确定性可靠性时
- 示例:
scripts/rotate_pdf.py用于PDF旋转任务 - 好处:Token高效、确定性,可以在不加载到上下文的情况下执行
- 注意:脚本可能仍需要被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能够在不将文件加载到上下文的情况下使用文件
技能中不应包含的内容
技能应仅包含直接支持其功能的必要文件。不要创建多余的文档或辅助文件,包括:
- README.md
- INSTALLATION_GUIDE.md
- QUICK_REFERENCE.md
- CHANGELOG.md
- 等等
技能应仅包含AI代理完成手头任务所需的信息。它不应包含关于创建它的过程、设置和测试程序、面向用户的文档等的辅助上下文。创建额外的文档文件只会增加混乱和困惑。
渐进式披露设计原则
技能使用三级加载系统来高效管理上下文:
- 元数据(名称 + 描述) - 始终在上下文中(~100字)
- SKILL.md正文 - 当技能触发时(<5k字)
- 捆绑资源 - 根据Claude需要(无限,因为脚本可以在不读取到上下文窗口的情况下执行)
渐进式披露模式
保持SKILL.md正文为必需内容且在500行以下,以最大限度地减少上下文膨胀。在接近此限制时将内容拆分为单独的文件。将内容拆分到其他文件时,从SKILL.md引用它们并清楚描述何时阅读它们非常重要,以确保技能的读者知道它们的存在以及何时使用它们。
关键原则: 当技能支持多个变体、框架或选项时,在SKILL.md中仅保留核心工作流程和选择指导。将变体特定细节(模式、示例、配置)移至单独的参考资料文件。
模式1:高级指南与参考资料
# PDF 处理
## 快速开始
使用pdfplumber提取文本:
[代码示例]
## 高级功能
- **表单填写**:参见[FORMS.md](FORMS.md)获取完整指南
- **API参考**:参见[REFERENCE.md](REFERENCE.md)获取所有方法
- **示例**:参见[EXAMPLES.md](EXAMPLES.md)获取常见模式
Claude仅在需要时加载FORMS.md、REFERENCE.md或EXAMPLES.md。
模式2:领域特定组织
对于具有多个领域的技能,按领域组织内容以避免加载不相关的上下文:
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:条件细节
显示基本内容,链接到高级内容:
# 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在预览时可以看到完整范围。
技能创建过程
技能创建涉及以下步骤:
- 通过具体示例理解技能
- 规划可重用的技能内容(脚本、参考资料、资产)
- 初始化技能(运行init_skill.py)
- 编辑技能(实现资源和编写SKILL.md)
- 打包技能(运行package_skill.py)
- 基于实际使用迭代
按顺序遵循这些步骤,只有在有明确理由不适用时才跳过。
步骤1:通过具体示例理解技能
仅当技能的使用模式已经清楚理解时才跳过此步骤。即使在处理现有技能时,它仍然有价值。
要创建有效的技能,清楚地了解技能如何使用的具体示例。这种理解可以来自直接用户示例或通过用户反馈验证的生成示例。
例如,在构建image-editor技能时,相关问题包括:
- "image-editor技能应该支持什么功能?编辑、旋转,还是其他?"
- "你能给出一些如何使用这个技能的例子吗?"
- "我可以想象用户要求诸如'从这张图像中去除红眼'或'旋转这张图像'之类的事情。你能想象这个技能还有其他使用方式吗?"
- "用户会说什么来触发这个技能?"
为了避免让用户不知所措,避免在单条消息中问太多问题。从最重要的问题开始,并根据需要跟进以提高有效性。
当清楚了解技能应支持的功能时,结束此步骤。
步骤2:规划可重用的技能内容
要将具体示例转化为有效的技能,通过以下方式分析每个示例:
- 考虑如何从头开始执行示例
- 识别在重复执行这些工作流程时哪些脚本、参考资料和资产会有帮助
示例:当构建pdf-editor技能以处理诸如"帮我旋转这个PDF"之类的查询时,分析显示:
- 旋转PDF每次都需要重写相同的代码
scripts/rotate_pdf.py脚本存储在技能中会有帮助
示例:当设计frontend-webapp-builder技能以处理诸如"为我构建一个待办事项应用"或"为我构建一个仪表板来跟踪我的步数"之类的查询时,分析显示:
- 编写前端webapp每次都需要相同的样板HTML/React
- 包含样板HTML/React项目文件的
assets/hello-world/模板存储在技能中会有帮助
示例:当构建big-query技能以处理诸如"今天有多少用户登录?"之类的查询时,分析显示:
- 查询BigQuery每次都需要重新发现表架构和关系
- 记录表架构的
references/schema.md文件存储在技能中会有帮助
要建立技能的内容,分析每个具体示例以创建要包含的可重用资源列表:脚本、参考资料和资产。
步骤3:初始化技能
此时,是时候实际创建技能了。
仅当正在开发的技能已经存在,并且需要迭代或打包时才跳过此步骤。在这种情况下,继续下一步。
当从头创建新技能时,始终运行init_skill.py脚本。该脚本方便地生成一个新的模板技能目录,自动包含技能所需的一切,使技能创建过程更加高效和可靠。
用法:
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文件,与用户共享。打包过程首先自动验证技能以确保它满足所有要求:
scripts/package_skill.py <path/to/skill-folder>
可选输出目录规范:
scripts/package_skill.py <path/to/skill-folder> ./dist
打包脚本将:
-
验证技能,自动检查:
- YAML frontmatter格式和必需字段
- 技能命名约定和目录结构
- 描述完整性和质量
- 文件组织和资源引用
-
如果验证通过,打包技能,创建以技能命名的.skill文件(例如,
my-skill.skill),包括所有文件并保持适当的目录结构以进行分发。.skill文件是带有.skill扩展名的zip文件。
如果验证失败,脚本将报告错误并退出而不创建包。修复任何验证错误并再次运行打包命令。
步骤6:迭代
在测试技能后,用户可能请求改进。这通常发生在使用技能后立即,带有技能表现如何的全新上下文。
迭代工作流程:
- 在实际任务上使用技能
- 注意挣扎或低效
- 识别SKILL.md或捆绑资源应如何更新
- 实施更改并再次测试