10 KiB
name, description, license
| name | description | license |
|---|---|---|
| skill-creator | 创建有效技能的指南。当用户希望创建新技能(或更新现有技能)以通过专业知识、工作流或工具集成来扩展 Claude 的能力时,应使用此技能。 | 完整条款见 LICENSE.txt |
技能创建指南
本指南提供创建有效技能的指导。
关于技能
技能是模块化、自包含的包,通过提供专业知识、工作流和工具来扩展 Claude 的能力。可以将它们视为特定领域或任务的"上岗指南"——它们将 Claude 从通用型代理转变为配备任何模型都无法完全掌握的程序性知识的专业化代理。
技能提供的内容
- 专业化工作流 - 特定领域的多步骤流程
- 工具集成 - 处理特定文件格式或 API 的说明
- 领域专业知识 - 公司特定知识、模式、业务逻辑
- 捆绑资源 - 用于复杂和重复性任务的脚本、参考资料和资源
技能的结构
每个技能由一个必需的 SKILL.md 文件和可选的捆绑资源组成:
skill-name/
├── SKILL.md (必需)
│ ├── YAML frontmatter 元数据 (必需)
│ │ ├── name: (必需)
│ │ └── description: (必需)
│ └── Markdown 指令 (必需)
└── 捆绑资源 (可选)
├── scripts/ - 可执行代码(Python/Bash 等)
├── references/ - 按需加载到上下文中的文档
└── assets/ - 输出中使用的文件(模板、图标、字体等)
SKILL.md(必需)
元数据质量: YAML frontmatter 中的 name 和 description 决定 Claude 何时使用该技能。请具体说明该技能的功能及使用时机。使用第三人称(例如 "This skill should be used when...",而非 "Use this skill when...")。
捆绑资源(可选)
脚本(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 或 references 文件中,而非两者兼有。除非信息真正是技能的核心,否则优先使用 references 文件存放详细信息——这既能保持 SKILL.md 精简,又能让信息可被发现且不占用上下文窗口。仅在 SKILL.md 中保留必要的过程性指令和工作流指导;将详细的参考资料、模式和示例移至 references 文件中。
资源(assets/)
不打算加载到上下文中,而是用于 Claude 生成的输出的文件。
- 何时包含:当技能需要用于最终输出的文件时
- 示例:品牌资源的
assets/logo.png、PowerPoint 模板的assets/slides.pptx、HTML/React 样板代码的assets/frontend-template/、字体的assets/font.ttf - 使用场景:模板、图片、图标、样板代码、字体、需要被复制或修改的示例文档
- 优势:将输出资源与文档分离,使 Claude 能够使用文件而无需将其加载到上下文中
渐进式披露设计原则
技能使用三级加载系统来有效管理上下文:
- 元数据(名称 + 描述) - 始终在上下文中(约 100 词)
- SKILL.md 正文 - 技能触发时加载(少于 5000 词)
- 捆绑资源 - 按 Claude 需要加载(无限制*)
*无限制,因为脚本可以在不读入上下文窗口的情况下执行。
技能创建流程
要创建技能,请按顺序遵循"技能创建流程",仅在存在明确理由认为不适用时跳过某些步骤。
第 1 步:通过具体示例理解技能
仅当技能的使用模式已经明确理解时,才可跳过此步骤。即使处理现有技能,此步骤仍然有价值。
要创建有效的技能,需要清晰地理解该技能将被如何使用的具体示例。这种理解可以来自用户直接提供的示例,也可以是通过用户反馈验证的生成示例。
例如,在构建图片编辑器技能时,相关问题包括:
- "图片编辑器技能应支持哪些功能?编辑、旋转,还有别的吗?"
- "你能举一些使用这个技能的例子吗?"
- "我可以想象用户会要求诸如'去除这张图片的红眼'或'旋转这张图片'之类的操作。你还能想到其他使用场景吗?"
- "用户说什么话应该触发这个技能?"
为避免使用户感到困扰,避免在单条消息中提出过多问题。从最重要的问题开始,根据需要跟进以获得更好的效果。
当对技能应支持的功能有清晰的认识时,即可结束此步骤。
第 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 实例更有效地执行这些任务。
从可复用的技能内容开始
开始实现时,从上述识别出的可复用资源入手:scripts/、references/ 和 assets/ 文件。请注意,此步骤可能需要用户输入。例如,在实现 brand-guidelines 技能时,用户可能需要提供要存储在 assets/ 中的品牌资源或模板,或要存储在 references/ 中的文档。
同时,删除技能不需要的任何示例文件和目录。初始化脚本在 scripts/、references/ 和 assets/ 中创建了示例文件以展示结构,但大多数技能不需要所有这些文件。
更新 SKILL.md
写作风格: 使用祈使/不定式形式(动词开头的指令)编写整个技能,而非第二人称。使用客观、指导性的语言(例如 "To accomplish X, do Y",而非 "You should do X" 或 "If you need to do X")。这可以保持 AI 消费的一致性和清晰度。
要完成 SKILL.md,请回答以下问题:
- 该技能的目的是什么?用几句话说明。
- 该技能应在何时使用?
- 在实践中,Claude 应如何使用该技能?上述开发的所有可复用技能内容都应被引用,以便 Claude 知道如何使用它们。
第 5 步:打包技能
技能就绪后,应将其打包为可分发的 zip 文件,供用户使用。打包过程会自动验证技能,以确保其满足所有要求:
scripts/package_skill.py <path/to/skill-folder>
可选的输出目录指定:
scripts/package_skill.py <path/to/skill-folder> ./dist
打包脚本将:
-
自动验证 技能,检查以下内容:
- YAML frontmatter 格式和必填字段
- 技能命名规范和目录结构
- 描述的完整性和质量
- 文件组织和资源引用
-
打包 技能(如果验证通过),创建一个以技能名称命名的 zip 文件(例如
my-skill.zip),包含所有文件并保持正确的目录结构以便分发。
如果验证失败,脚本将报告错误并退出,不创建包。修复所有验证错误后重新运行打包命令。
第 6 步:迭代
测试技能后,用户可能会提出改进要求。这通常发生在使用技能之后,并且对技能的表现有清晰的上下文时。
迭代工作流:
- 在实际任务中使用该技能
- 发现困难或低效之处
- 确定 SKILL.md 或捆绑资源应如何更新
- 实施更改并再次测试