skill-creator
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseSkill Creator
Skill Creator
This skill provides guidance for creating effective skills.
本Skill提供创建有效Skill的指导。
About Skills
关于Skill
Skills are modular, self-contained packages that extend Claude's capabilities by providing
specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
domains or tasks—they transform Claude from a general-purpose agent into a specialized agent
equipped with procedural knowledge that no model can fully possess.
IMPORTANT:
- Skills are not documentation, they are practical instructions for Claude Code to use the tools, packages, plugins or APIs to achieve the tasks.
- Each skill teaches Claude how to perform a specific development task, not what a tool does.
- Claude Code can activate multiple skills automatically to achieve the user's request.
Skill是模块化、独立的包,通过提供专业知识、工作流和工具来扩展Claude的能力。可以将其视为特定领域或任务的“入门指南”——它们能将Claude从通用型Agent转变为具备过程知识的专业型Agent,而这类知识是任何模型都无法完全拥有的。
重要提示:
- Skill不是文档,而是供Claude Code使用工具、包、插件或API来完成任务的实用说明。
- 每个Skill都教授Claude如何执行特定的开发任务,而非介绍工具的功能。
- Claude Code可自动激活多个Skill来完成用户的请求。
What Skills Provide
Skill的作用
- Specialized workflows - Multi-step procedures for specific domains
- Tool integrations - Instructions for working with specific file formats or APIs
- Domain expertise - Company-specific knowledge, schemas, business logic
- Bundled resources - Scripts, references, and assets for complex and repetitive tasks
- 专业工作流 - 特定领域的多步骤流程
- 工具集成 - 处理特定文件格式或API的操作说明
- 领域专业知识 - 公司专属知识、数据结构、业务逻辑
- 捆绑资源 - 用于复杂重复任务的脚本、参考资料和资产
Anatomy of a Skill
Skill的结构
Every skill consists of a required SKILL.md file and optional bundled resources:
.claude/skills/
└── skill-name/
├── SKILL.md (required)
│ ├── YAML frontmatter metadata (required)
│ │ ├── name: (required)
│ │ ├── description: (required)
│ │ ├── license: (optional)
│ │ └── version: (optional)
│ └── 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都包含一个必填的SKILL.md文件和可选的捆绑资源:
.claude/skills/
└── skill-name/
├── SKILL.md (required)
│ ├── YAML frontmatter metadata (required)
│ │ ├── name: (required)
│ │ ├── description: (required)
│ │ ├── license: (optional)
│ │ └── version: (optional)
│ └── Markdown instructions (required)
└── Bundled Resources (optional)
├── scripts/ - 可执行代码(Python/Bash等)
├── references/ - 可按需加载到上下文的文档
└── assets/ - 输出中使用的文件(模板、图标、字体等)Requirements (IMPORTANT)
要求(重要提示)
- Skill should be combined into specific topics, for example: ,
cloudflare,cloudflare-r2,cloudflare-workers,dockershould be combined intogclouddevops - should be less than 100 lines and include the references of related markdown files and scripts.
SKILL.md - Each script or referenced markdown file should be also less than 100 lines, remember that you can always split them into multiple files (progressive disclosure principle).
- Descriptions in metadata of files should be both concise and still contains enough usecases of the references and scripts, this will help skills can be activated automatically during the implementation process of Claude Code.
SKILL.md - Referenced markdowns:
- Sacrifice grammar for the sake of concision when writing these files.
- Can reference other markdown files or scripts as well.
- Referenced scripts:
- Prefer nodejs or python scripts instead of bash script, because bash scripts are not well-supported on Windows.
- If you're going to write python scripts, make sure you have
requirements.txt - Make sure scripts respect file follow this order:
.env>process.env>.claude/skills/${SKILL}/.env>.claude/skills/.env.claude/.env - Create files to show the required environment variables.
.env.example - Always write tests for these scripts.
IMPORTANT:
- Always keep in mind that and reference files should be token consumption efficient, so that progressive disclosure can be leveraged at best.
SKILL.md - should be less than 100 lines
SKILL.md - Referenced markdown files should be also less than 100 lines, remember that you can always split them into multiple files (progressive disclosure principle).
- Referenced scripts: no limit on length, just make sure it works, no compile issues, no runtime issues, no dependencies issues, no environment issues, no platform issues.
Why?
Better context engineering: leverage progressive disclosure technique of Agent Skills, when agent skills are activated, Claude Code will consider to load only relevant files into the context, instead of reading all long as before.
SKILL.md- Skill应按特定主题归类,例如:、
cloudflare、cloudflare-r2、cloudflare-workers、docker应归类到gcloud主题下devops - 文件应少于100行,并包含相关markdown文件和脚本的引用
SKILL.md - 每个脚本或引用的markdown文件也应少于100行,记住可以将内容拆分为多个文件(遵循渐进式披露原则)
- 元数据中的描述应简洁且包含足够多的引用和脚本使用场景,这有助于Claude Code在执行过程中自动激活Skill
SKILL.md - 引用的markdown文件:
- 编写时优先保证简洁性,可适当牺牲语法完整性
- 也可引用其他markdown文件或脚本
- 引用的脚本:
- 优先选择Node.js或Python脚本,而非Bash脚本,因为Bash脚本在Windows上的支持性不佳
- 若编写Python脚本,请确保包含文件
requirements.txt - 确保脚本遵循以下文件加载顺序:
.env>process.env>.claude/skills/${SKILL}/.env>.claude/skills/.env.claude/.env - 创建文件以展示所需的环境变量
.env.example - 务必为脚本编写测试用例
重要提示:
- 始终牢记和引用文件应尽量减少Token消耗,以便最大程度利用渐进式披露机制
SKILL.md - 应少于100行
SKILL.md - 引用的markdown文件也应少于100行,记住可以将内容拆分为多个文件(遵循渐进式披露原则)
- 引用的脚本:无长度限制,但需确保能正常运行,无编译、运行时、依赖、环境或平台问题
原因:
更优的上下文工程:利用Agent Skills的渐进式披露技术,当Agent Skills被激活时,Claude Code会仅将相关文件加载到上下文中,而非像以前那样读取整个冗长的文件。
SKILL.mdSKILL.md (required)
SKILL.md(必填)
File name: (uppercase)
File size: Under 100 lines, if you need more, plit it to multiple files in folder.
is always short and concise, straight to the point, treat it as a quick reference guide.
SKILL.mdreferencesSKILL.mdMetadata Quality: The and in YAML frontmatter determine when Claude will use the skill. Be specific about what the skill does and when to use it. Use the third-person (e.g. "This skill should be used when..." instead of "Use this skill when...").
namedescription文件名: (大写)
文件大小: 不超过100行,若内容过多,可拆分为文件夹中的多个文件
应始终简洁明了、直奔主题,可将其视为快速参考指南。
SKILL.mdreferencesSKILL.md元数据质量: YAML前置元数据中的和决定了Claude何时使用该Skill。请明确说明Skill的功能和适用场景,使用第三人称表述(例如:“当...时应使用本Skill”而非“当...时使用本Skill”)。
namedescriptionBundled Resources (optional)
捆绑资源(可选)
Scripts (scripts/
)
scripts/脚本(scripts/
)
scripts/Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
- When to include: When the same code is being rewritten repeatedly or deterministic reliability is needed
- Example: for PDF rotation tasks
scripts/rotate_pdf.py - Benefits: Token efficient, deterministic, may be executed without loading into context
- Note: Scripts may still need to be read by Claude for patching or environment-specific adjustments
IMPORTANT:
- Write tests for scripts.
- Run tests and make sure it works, if tests fail, fix them and run tests again, repeat until tests pass.
- Run scripts manually with some usecases to make sure it works.
- Make sure scripts respect file follow this order:
.env>process.env>.claude/skills/docs-seeker/.env>.claude/skills/.env.claude/.env
用于需要确定性可靠性或重复编写的任务的可执行代码(Python/Bash等)。
- 适用场景:当相同代码被重复编写,或需要确定性可靠性时
- 示例:用于PDF旋转任务的
scripts/rotate_pdf.py - 优势:Token消耗低、结果确定,无需加载到上下文即可执行
- 注意:Claude可能仍需读取脚本以进行补丁或环境特定调整
重要提示:
- 为脚本编写测试用例
- 运行测试确保脚本正常工作,若测试失败,修复后重新测试,直至通过
- 手动运行脚本并测试部分用例以确保其正常工作
- 确保脚本遵循以下文件加载顺序:
.env>process.env>.claude/skills/docs-seeker/.env>.claude/skills/.env.claude/.env
References (references/
)
references/参考资料(references/
)
references/Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.
- When to include: For documentation that Claude should reference while working
- Examples: for financial schemas,
references/finance.mdfor company NDA template,references/mnda.mdfor company policies,references/policies.mdfor API specificationsreferences/api_docs.md - Use cases: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
- Benefits: Keeps SKILL.md lean, loaded only when Claude determines it's needed
- Best practice: If files are large (>100 lines), include grep search patterns in SKILL.md
- Avoid duplication: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
IMPORTANT:
- Referenced markdown files should be also less than 100 lines, remember that you can always split them into multiple files (progressive disclosure principle).
- Referenced markdown files are practical instructions for Claude Code to use the tools, packages, plugins or APIs to achieve the tasks.
- Each skill teaches Claude how to perform a specific development task, not what a tool does.
供Claude在工作过程中按需加载到上下文的文档和参考资料。
- 适用场景:Claude工作时需要参考的文档
- 示例:用于财务数据结构的、用于公司保密协议模板的
references/finance.md、用于公司政策的references/mnda.md、用于API规范的references/policies.mdreferences/api_docs.md - 使用场景:数据库结构、API文档、领域知识、公司政策、详细工作流指南
- 优势:保持SKILL.md简洁,仅在Claude需要时加载
- 最佳实践:若文件过大(>100行),在SKILL.md中包含grep搜索模式
- 避免重复:信息应仅存在于SKILL.md或参考文件中,不可重复。除非是Skill的核心内容,否则优先将详细信息放在参考文件中——这能保持SKILL.md简洁,同时让信息可被发现且不占用过多上下文窗口。仅在SKILL.md中保留必要的过程说明和工作流指导;将详细参考资料、数据结构和示例移至参考文件中。
重要提示:
- 引用的markdown文件也应少于100行,记住可以将内容拆分为多个文件(遵循渐进式披露原则)
- 引用的markdown文件是供Claude Code使用工具、包、插件或API完成任务的实用说明
- 每个Skill都教授Claude如何执行特定的开发任务,而非介绍工具的功能
Assets (assets/
)
assets/资源文件(assets/
)
assets/Files not intended to be loaded into context, but rather used within the output Claude produces.
- When to include: When the skill needs files that will be used in the final output
- Examples: for brand assets,
assets/logo.pngfor PowerPoint templates,assets/slides.pptxfor HTML/React boilerplate,assets/frontend-template/for typographyassets/font.ttf - Use cases: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
- Benefits: Separates output resources from documentation, enables Claude to use files without loading them into context
无需加载到上下文,而是用于Claude生成的最终输出中的文件。
- 适用场景:Skill需要用于最终输出的文件时
- 示例:用于品牌资产的、用于PowerPoint模板的
assets/logo.png、用于HTML/React模板的assets/slides.pptx、用于字体的assets/frontend-template/assets/font.ttf - 使用场景:模板、图片、图标、样板代码、字体、可复制或修改的示例文档
- 优势:将输出资源与文档分离,使Claude无需加载即可使用这些文件
Progressive Disclosure Design Principle
渐进式披露设计原则
Skills use a three-level loading system to manage context efficiently:
- Metadata (name + description) - Always in context (~100 words)
- SKILL.md body - When skill triggers (<5k words)
- Bundled resources - As needed by Claude (Unlimited*)
*Unlimited because scripts can be executed without reading into context window.
Skill采用三级加载系统来高效管理上下文:
- 元数据(名称+描述) - 始终在上下文中(约100词)
- SKILL.md主体 - Skill被触发时加载(<5000词)
- 捆绑资源 - Claude按需加载(无限制*)
*无限制是因为脚本可在不读取到上下文窗口的情况下执行。
Skill Creation Process
Skill创建流程
To create a skill, follow the "Skill Creation Process" in order, skipping steps only if there is a clear reason why they are not applicable.
创建Skill时,请按顺序遵循以下“Skill创建流程”,仅当有明确理由说明某步骤不适用时才可跳过。
Step 1: Understanding the Skill with Concrete Examples
步骤1:通过具体示例理解Skill
Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
For example, when building an image-editor skill, relevant questions include:
- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
- "Can you give some examples of how this skill would be used?"
- "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
- "What would a user say that should trigger this skill?"
To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
Conclude this step when there is a clear sense of the functionality the skill should support.
仅当Skill的使用模式已明确时才可跳过此步骤。即使处理现有Skill,此步骤仍有价值。
要创建有效的Skill,需清晰理解Skill的具体使用示例。这种理解可来自直接的用户示例,或经用户反馈验证的生成示例。
例如,构建图像编辑器Skill时,相关问题包括:
- “图像编辑器Skill应支持哪些功能?编辑、旋转,还是其他?”
- “能否举例说明该Skill的使用场景?”
- “我能想到用户会提出‘去除这张图片的红眼’或‘旋转这张图片’之类的请求。还有其他使用场景吗?”
- “用户说什么话时应触发此Skill?”
为避免给用户造成负担,请勿在一条消息中提出过多问题。先从最重要的问题开始,必要时再跟进,以提高效率。
当明确Skill应支持的功能时,即可结束此步骤。
Step 2: Planning the Reusable Skill Contents
步骤2:规划可复用的Skill内容
To turn concrete examples into an effective skill, analyze each example by:
- Considering how to execute on the example from scratch
- Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
Example: When building a skill to handle queries like "Help me rotate this PDF," the analysis shows:
pdf-editor- Rotating a PDF requires re-writing the same code each time
- A script would be helpful to store in the skill
scripts/rotate_pdf.py
Example: When designing a skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
frontend-webapp-builder- Writing a frontend webapp requires the same boilerplate HTML/React each time
- An template containing the boilerplate HTML/React project files would be helpful to store in the skill
assets/hello-world/
Example: When building a skill to handle queries like "How many users have logged in today?" the analysis shows:
big-query- Querying BigQuery requires re-discovering the table schemas and relationships each time
- A file documenting the table schemas would be helpful to store in the skill
references/schema.md
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
- Make sure scripts respect file follow this order:
.env>process.env>.claude/skills/docs-seeker/.env>.claude/skills/.env.claude/.env - Make sure scripts have tests.
要将具体示例转化为有效的Skill,请按以下步骤分析每个示例:
- 考虑如何从头开始执行该示例
- 识别重复执行这些工作流时需要的脚本、参考资料和资源文件
示例:构建用于处理“帮我旋转这个PDF”等请求的Skill时,分析结果如下:
pdf-editor- 旋转PDF需要重复编写相同的代码
- 在Skill中存储脚本会很有帮助
scripts/rotate_pdf.py
示例:设计用于处理“帮我构建一个待办事项应用”或“帮我构建一个步数追踪仪表盘”等请求的Skill时,分析结果如下:
frontend-webapp-builder- 构建前端Web应用需要重复编写相同的HTML/React样板代码
- 在Skill中存储包含HTML/React项目样板文件的模板会很有帮助
assets/hello-world/
示例:构建用于处理“今天有多少用户登录?”等请求的Skill时,分析结果如下:
big-query- 查询BigQuery需要重复查找表结构和关系
- 在Skill中存储记录表结构的文件会很有帮助
references/schema.md
要确定Skill的内容,请分析每个具体示例,列出需包含的可复用资源:脚本、参考资料和资源文件。
- 确保脚本遵循以下文件加载顺序:
.env>process.env>.claude/skills/docs-seeker/.env>.claude/skills/.env.claude/.env - 确保脚本包含测试用例
Step 3: Initializing the Skill
步骤3:初始化Skill
At this point, it is time to actually create the skill.
Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
When creating a new skill from scratch, always run the script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
init_skill.pyUsage:
bash
scripts/init_skill.py <skill-name> --path <output-directory>The script:
- Creates the skill directory at the specified path
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
- Creates example resource directories: ,
scripts/, andreferences/assets/ - Adds example files in each directory that can be customized or deleted
After initialization, customize or remove the generated SKILL.md and example files as needed.
此时即可开始实际创建Skill。
仅当正在开发的Skill已存在,且需要迭代或打包时才可跳过此步骤。这种情况下,请直接进入下一步。
从头创建新Skill时,请务必运行脚本。该脚本可方便地生成新的Skill模板目录,自动包含Skill所需的所有内容,使Skill创建过程更高效、可靠。
init_skill.py用法:
bash
scripts/init_skill.py <skill-name> --path <output-directory>该脚本会:
- 在指定路径创建Skill目录
- 生成包含正确前置元数据和待办事项占位符的SKILL.md模板
- 创建示例资源目录:、
scripts/和references/assets/ - 在每个目录中添加可自定义或删除的示例文件
初始化完成后,可根据需要自定义或删除生成的SKILL.md和示例文件。
Step 4: Edit the Skill
步骤4:编辑Skill
When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Focus on including information that would be beneficial and non-obvious to Claude. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Claude instance execute these tasks more effectively.
编辑(新生成或现有)Skill时,请记住该Skill是供另一个Claude实例使用的。请重点包含对Claude有帮助且非显而易见的信息。思考哪些过程知识、领域特定细节或可复用资源能帮助另一个Claude实例更有效地执行这些任务。
Start with Reusable Skill Contents
从可复用Skill内容开始
To begin implementation, start with the reusable resources identified above: , , and files. Note that this step may require user input. For example, when implementing a skill, the user may need to provide brand assets or templates to store in , or documentation to store in .
scripts/references/assets/brand-guidelinesassets/references/Also, delete any example files and directories not needed for the skill. The initialization script creates example files in , , and to demonstrate structure, but most skills won't need all of them.
scripts/references/assets/开始实现时,请从上述确定的可复用资源入手:、和文件。请注意,此步骤可能需要用户输入。例如,构建Skill时,用户可能需要提供存储在中的品牌资产或模板,或存储在中的文档。
scripts/references/assets/brand-guidelinesassets/references/此外,请删除Skill不需要的示例文件和目录。初始化脚本会在、和中创建示例文件以展示结构,但大多数Skill不需要所有这些文件。
scripts/references/assets/Update SKILL.md
更新SKILL.md
Writing Style: Write the entire skill using imperative/infinitive form (verb-first instructions), not second person. Use objective, instructional language (e.g., "To accomplish X, do Y" rather than "You should do X" or "If you need to do X"). This maintains consistency and clarity for AI consumption.
To complete SKILL.md, answer the following questions:
- What is the purpose of the skill, in a few sentences?
- When should the skill be used?
- In practice, how should Claude use the skill? All reusable skill contents developed above should be referenced so that Claude knows how to use them.
写作风格: 整个Skill请使用命令式/不定式形式(动词开头的指令),而非第二人称。使用客观的说明性语言(例如:“要完成X,请执行Y”而非“你应该做X”或“如果你需要做X”)。这能保持AI消费时的一致性和清晰度。
要完成SKILL.md,请回答以下问题:
- Skill的用途是什么?请用几句话说明
- 何时应使用该Skill?
- 实际使用时,Claude应如何使用该Skill?请引用上述开发的所有可复用Skill内容,以便Claude了解使用方法
Step 5: Packaging a Skill
步骤5:打包Skill
Once the skill is ready, it should be packaged into a distributable zip file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
bash
scripts/package_skill.py <path/to/skill-folder>Optional output directory specification:
bash
scripts/package_skill.py <path/to/skill-folder> ./distThe packaging script will:
-
Validate the skill automatically, checking:
- YAML frontmatter format and required fields
- Skill naming conventions and directory structure
- Description completeness and quality
- File organization and resource references
-
Package the skill if validation passes, creating a zip file named after the skill (e.g.,) that includes all files and maintains the proper directory structure for distribution.
my-skill.zip
If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
Skill准备就绪后,应将其打包为可分发的zip文件与用户共享。打包过程会自动先验证Skill,确保其符合所有要求:
bash
scripts/package_skill.py <path/to/skill-folder>可选的输出目录指定:
bash
scripts/package_skill.py <path/to/skill-folder> ./dist打包脚本会:
-
验证:自动验证Skill,检查:
- YAML前置元数据格式和必填字段
- Skill命名规范和目录结构
- 描述的完整性和质量
- 文件组织和资源引用情况
-
打包:若验证通过,则打包Skill,创建以Skill命名的zip文件(例如:),包含所有文件并保持分发所需的正确目录结构。
my-skill.zip
若验证失败,脚本会报告错误并退出,不创建包。修复所有验证错误后,请重新运行打包命令。
Step 6: Iterate
步骤6:迭代优化
After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
Iteration workflow:
- Use the skill on real tasks
- Notice struggles or inefficiencies
- Identify how SKILL.md or bundled resources should be updated
- Implement changes and test again
测试Skill后,用户可能会提出改进请求。通常这会发生在使用Skill后不久,此时用户对Skill的表现有清晰的印象。
迭代工作流:
- 在实际任务中使用Skill
- 注意Skill的不足或低效之处
- 确定应如何更新SKILL.md或捆绑资源
- 实施更改并重新测试
References
参考资料
- Agent Skills
- Agent Skills Spec
- Agent Skills Overview
- Best Practices
- Agent Skills
- Agent Skills Spec
- Agent Skills Overview
- Best Practices