tomevault-io Skill Creator
本技能提供创建有效技能的指导。
关于技能
技能是模块化、自包含的软件包，通过提供专门知识、工作流程和工具来扩展Claude的能力。可以将它们视为特定领域或任务的"入职指南"——它们将Claude从通用智能体转变为配备过程性知识的专业智能体，这些知识是任何模型都无法完全拥有的。
技能提供的内容
- 专门工作流程 - 特定领域的多步骤程序
- 工具集成 - 处理特定文件格式或API的指令
- 领域专业知识 - 公司特定知识、模式、业务逻辑
- 捆绑资源 - 用于复杂和重复任务的脚本、参考资料和资产
核心原则
简洁是关键
上下文窗口是公共资源。技能与Claude需要的其他所有内容共享上下文窗口：系统提示、对话历史、其他技能的元数据以及实际的用户请求。
默认假设：Claude已经非常智能。 只添加Claude尚未拥有的上下文。挑战每一条信息："Claude真的需要这个解释吗？"以及"这个段落的token成本是否合理？"
优先使用简洁的示例而不是冗长的解释。
设置适当的自由度
将具体性级别与任务的脆弱性和可变性相匹配：
高自由度（基于文本的指令）：当多种方法都有效、决策依赖于上下文或启发式方法指导方法时使用。
中等自由度（带参数的伪代码或脚本）：当存在首选模式、一些变化是可接受的或配置影响行为时使用。
低自由度（特定脚本、少量参数）：当操作脆弱且易出错、一致性至关重要或必须遵循特定序列时使用。
将Claude想象成在探索路径：有悬崖的狭窄桥梁需要特定的护栏（低自由度），而开阔的田野允许许多路线（高自由度）。
技能的构成结构
每个技能都由必需的SKILL.md文件和可选的references组成：
skill-name/
├── SKILL.md (必需)
│ ├── YAML前置元数据 (必需)
│ │ ├── name: (必需)
│ │ └── description: (必需)
│ └── Markdown指令 (必需)
└── references (可选)
├── scripts/ - 可执行代码 (TypeScript/Node.js/etc.)
├── references/ - 根据需要加载到上下文中的文档
└── assets/ - 输出中使用的文件 (模板、图标、字体等)
SKILL.md (必需)
每个SKILL.md包含：
- 前置元数据 (YAML)：包含
name和description字段。这些是Claude读取以确定何时使用技能的唯一字段，因此在描述技能是什么以及何时应该使用时，清晰和全面非常重要。 - 正文 (Markdown)：使用技能的指令和指导。仅在技能触发后加载（如果有的话）。
references (可选)
Scripts (scripts/)
可执行代码（TypeScript/Node.js/etc.），用于需要确定性可靠性或重复重写的任务。
- 何时包含：当同一代码被重复重写或需要确定性可靠性时
- 示例：用于PDF旋转任务的
scripts/rotate_pdf.ts - 好处：token高效、确定性、可以在不加载到上下文的情况下执行
- 注意：Claude可能仍需要读取脚本进行补丁或环境特定调整
References (references/)
文档和参考资料，旨在根据需要加载到上下文中，以指导Claude的过程和思考。
- 何时包含：用于Claude在工作时应该引用的文档
- 示例：用于财务模式的
references/finance.md、用于公司NDA模板的references/mnda.md、用于公司政策的references/policies.md、用于API规范的references/api_docs.md - 用例：数据库模式、API文档、领域知识、公司政策、详细工作流程指南
- 好处：保持SKILL.md精简，仅在Claude确定需要时加载
- 最佳实践：如果文件较大（>10k字），在SKILL.md中包含grep搜索模式
- 避免重复：信息应该存在于SKILL.md或references文件中，而不是两者都存在。详细信息优先使用references文件，除非它真正是技能的核心——这保持SKILL.md精简，同时使信息可发现而不会占用上下文窗口。只在SKILL.md中保留基本的过程指令和工作流程指导；将详细的参考资料、模式和示例移至references文件。
Assets (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代理完成手头任务所需的信息。它不应包含关于创建过程的辅助上下文、设置和测试程序、面向用户的文档等。创建额外的文档文件只会增加混乱和困惑。
渐进式披露设计原则
技能使用三级加载系统来有效管理上下文：
- 元数据（名称 + 描述） - 始终在上下文中（约100字）
- SKILL.md正文 - 当技能触发时（<5k字）
- references - 根据Claude需要（无限制，因为脚本可以在不读取到上下文窗口的情况下执行）
渐进式披露模式
保持SKILL.md正文精简并在500行以下，以最小化上下文膨胀。在接近此限制时将内容拆分为单独的文件。将内容拆分到其他文件时，非常重要的一点是要在SKILL.md中引用它们，并清楚描述何时读取它们，以确保技能的阅读者知道它们的存在以及何时使用它们。
关键原则： 当技能支持多个变体、框架或选项时，只在SKILL.md中保留核心工作流程和选择指导。将变体特定的详细信息（模式、示例、配置）移至单独的reference文件。
模式1：带有references的高级指南
# PDF Processing
## Quick start
使用pdfplumber提取文本：
[code example]
## Advanced features
- **表单填写**：完整指南见[FORMS.md](FORMS.md)
- **API参考**：所有方法见[REFERENCE.md](REFERENCE.md)
- **示例**：常见模式见[EXAMPLES.md](EXAMPLES.md)
Claude仅在需要时加载FORMS.md、REFERENCE.md或EXAMPLES.md。
**模式2：特定领域的组织**
对于具有多个领域的技能，按领域组织内容以避免加载不相关的上下文：
```text
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 Processing
## Creating documents
使用docx-js创建新文档。参见[DOCX-JS.md](DOCX-JS.md)。
## Editing documents
对于简单编辑，直接修改XML。
**对于修订跟踪**：参见[REDLINING.md](REDLINING.md)
**对于OOXML详细信息**：参见[OOXML.md](OOXML.md)
Claude仅在用户需要这些功能时读取REDLINING.md或OOXML.md。
**重要指导原则：**
- **避免深度嵌套的references** - 保持references距离SKILL.md只有一级深度。所有reference文件都应直接从SKILL.md链接。
- **结构化较长的reference文件** - 对于超过100行的文件，在顶部包含目录，以便Claude在预览时能看到完整范围。
## 技能创建过程
技能创建涉及这些步骤：
1. 通过具体示例理解技能
2. 规划可重用的技能内容（脚本、参考资料、资产）
3. 初始化技能（运行init_skill.ts）
4. 编辑技能（实现资源和编写SKILL.md）
5. 打包技能（运行package_skill.ts）
6. 基于实际使用进行迭代
按顺序遵循这些步骤，只有在明确原因不适用的前提下才能跳过。
### 步骤1：通过具体示例理解技能
只有在技能的使用模式已经清楚理解时才跳过此步骤。即使在处理现有技能时，这一步仍然有价值。
要创建有效的技能，清楚了解技能将如何使用的具体示例。这种理解可以来自直接的用户示例或通过用户反馈验证的生成示例。
例如，在构建image-editor技能时，相关问题包括：
- "image-editor技能应该支持什么功能？编辑、旋转，还是其他？"
- "你能给出一些如何使用这个技能的示例吗？"
- "我可以想象用户要求像'从这张图片中去除红眼'或'旋转这张图片'之类的事情。你能想象这个技能的其他使用方式吗？"
- "用户会说些什么来触发这个技能？"
为了避免压倒用户，避免在单条消息中问太多问题。从最重要的问题开始，根据需要跟进以获得更好的效果。
当清楚地了解技能应该支持的功能时结束此步骤。
### 步骤2：规划可重用的技能内容
要将具体示例转化为有效技能，通过以下方式分析每个示例：
1. 考虑如何从头开始执行示例
2. 识别在重复执行这些工作流程时哪些脚本、参考资料和资产会有帮助
示例：当构建`pdf-editor`技能来处理像"帮我旋转这个PDF"这样的查询时，分析显示：
1. 旋转PDF每次都需要重写相同的代码
2. 一个`scripts/rotate_pdf.ts`脚本会很有帮助，可以存储在技能中
示例：当设计`frontend-webapp-builder`技能来处理像"为我构建一个todo应用"或"为我构建一个跟踪步数的仪表板"这样的查询时，分析显示：
1. 编写前端webapp每次都需要相同的样板HTML/React
2. 一个包含样板HTML/React项目文件的`assets/hello-world/`模板会很有帮助，可以存储在技能中
示例：当构建`big-query`技能来处理像"今天有多少用户登录？"这样的查询时，分析显示：
1. 查询BigQuery每次都需要重新发现表模式和关系
2. 一个记录表模式的`references/schema.md`文件会很有帮助，可以存储在技能中
要建立技能的内容，分析每个具体示例以创建要包含的可重用资源列表：脚本、参考资料和资产。
### 步骤3：初始化技能
此时，是时候实际创建技能了。
只有在正在开发的技能已经存在，并且需要迭代或打包时才跳过此步骤。在这种情况下，继续下一步。
从零开始创建新技能时，始终运行`init_skill.ts`脚本。该脚本方便地生成一个新的模板技能目录，自动包含技能所需的一切，使技能创建过程更加高效和可靠。
用法：
```bash
npx ts-node .claude/skills/skill-creator/scripts/init_skill.ts <skill-name> --path <path>
该脚本：
- 在指定路径创建技能目录
- 生成带有适当前置元数据和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
写作指导原则： 始终使用命令式/不定式形式。
前置元数据
编写带有name和description的YAML前置元数据：
name：技能名称description：这是技能的主要触发机制，帮助Claude理解何时使用技能。- 包括技能做什么以及何时使用的特定触发器/上下文。
- 在这里包含所有"何时使用"信息 - 不要在正文中。正文只在触发后加载，所以正文中的"何时使用此技能"部分对Claude没有帮助。
docx技能的描述示例："支持修订跟踪、注释、格式保持和文本提取的综合文档创建、编辑和分析。当Claude需要处理专业文档（.docx文件）时使用：(1) 创建新文档，(2) 修改或编辑内容，(3) 处理修订跟踪，(4) 添加注释，或任何其他文档任务"
不要在YAML前置元数据中包含任何其他字段。
正文
编写使用技能及其references的指令。
步骤5：打包技能
一旦技能开发完成，必须将其打包成可分发的.skill文件，与用户共享。打包过程首先自动验证技能以确保满足所有要求：
npx ts-node .claude/skills/skill-creator/scripts/package_skill.ts <path/to/skill-folder>
可选输出目录规范：
npx ts-node .claude/skills/skill-creator/scripts/package_skill.ts <path/to/skill-folder> ./dist
打包脚本将：
自动验证技能，检查：
- YAML前置元数据格式和必需字段
- 技能命名约定和目录结构
- 描述的完整性和质量
- 文件组织和资源引用
如果验证通过，打包技能，创建以技能命名的.skill文件（例如，
my-skill.skill），包含所有文件并保持适当的目录结构以供分发。.skill文件是带有.skill扩展名的zip文件。
如果验证失败，脚本将报告错误并退出而不创建包。修复任何验证错误并再次运行打包命令。
步骤6：迭代
测试技能后，用户可能要求改进。这通常在使用技能后立即发生，对技能的表现有新鲜的上下文。
迭代工作流程：
- 在实际任务上使用技能
- 注意到困难或效率低下
- 识别SKILL.md或references应该如何更新
- 实施更改并再次测试
Converted and distributed by TomeVault — claim your Tome and manage your conversions.