技能发展
- 作者仓库星标 223
- 作者仓库 ordinary-claude-skills
- 领域
- 工程开发
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 92 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @Microck · v0.1.0 · 未声明许可证
- 上下文用量评级
- 较高消耗
- 接入复杂程度
- 需简单配置
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 运行环境要求
- Python
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 命令执行
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
仅当已经清楚地了解技能的使用模式时才跳过此步骤。即使使用现有技能,它仍然很有价值。要创建有效的技能,请清楚地了解如何使用该技能的具体示例。这种理解可以来自直接的用户示例,也可以来自通过用户反馈验证的生成示例。例如,在培养图像编辑技能时,相关问题包括:
要将具体示例转化为有效的技能,请通过以下方式分析每个示例: 考虑如何从头开始执行示例 确定重复执行这些工作流程时哪些脚本、引用和资源会有所帮助 示例:当构建`pdf-editor` 技能来处理“帮我旋转此 PDF”之类的查询时,分析显示:旋转 PDF 需要每次重新编写相同的代码
对于 Claude Code 插件,创建技能目录结构: 注意:与使用 `init_skill.py` 的通用技能创建器不同,插件技能直接在插件的 `skills/` 目录中创建,具有更简单的手动结构。
编辑(新创建的或现有的)技能时,请记住该技能正在创建供另一个 Claude 实例使用。重点关注包括对克劳德有益且非显而易见的信息。考虑哪些程序知识、特定领域的细节或可重用资产可以帮助另一个 Claude 实例更有效地执行这些任务。从可重复使用的技能内容开始
对于插件技能,验证与通用技能不同: 检查结构:`plugin-name/skills/skill-name/`中的技能目录 验证 SKILL.md:具有名称和描述的前题 检查触发短语:描述包括特定用户查询 验证写作风格:正文使用命令式/不定式形式,而不是第二人称
测试技能后,用户可以请求改进。通常,这种情况会在使用该技能后立即发生,并提供该技能如何执行的新背景。迭代工作流程:在实际任务中使用该技能 注意困难或效率低下 确定应如何更新 SKILL.md 或捆绑资源
# Skill Development for Claude Code Plugins
This skill provides guidance for creating effective skills for Claude Code plugins.
## About Skills
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.
### What Skills Provide
1. Specialized workflows - Multi-step procedures for specific domains
2. Tool integrations - Instructions for working with specific file formats or APIs
3. Domain expertise - Company-specific knowledge, schemas, business logic
4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
### Anatomy of a Skill
Every skill consists of a required SKILL.md file and optional bundled resources:
```
skill-name/
├── SKILL.md (required)
│ ├── YAML frontmatter metadata (required)
│ │ ├── name: (required)
│ │ └── description: (required)
│ └── 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.md (required)
**Metadata Quality:** The `name` and `description` 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...").
#### Bundled Resources (optional)
##### 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**: `scripts/rotate_pdf.py` for PDF rotation tasks
- **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
##### 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**: `references/finance.md` for financial schemas, `references/mnda.md` for company NDA template, `references/policies.md` for company policies, `references/api_docs.md` for API specifications
- **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 (>10k words), 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.
##### 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**: `assets/logo.png` for brand assets, `assets/slides.pptx` for PowerPoint templates, `assets/frontend-template/` for HTML/React boilerplate, `assets/font.ttf` for typography
- **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
### Progressive Disclosure Design Principle
Skills use a three-level loading system to manage context efficiently:
1. **Metadata (name + description)** - Always in context (~100 words)
2. **SKILL.md body** - When skill triggers (<5k words)
3. **Bundled resources** - As needed by Claude (Unlimited*)
*Unlimited because scripts can be executed without reading into context window.
## Skill Creation Process
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.
### Step 1: Understanding the Skill with Concrete Examples
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.
### Step 2: Planning the Reusable Skill Contents
To turn concrete examples into an effective skill, analyze each example by:
1. Considering how to execute on the example from scratch
2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
1. Rotating a PDF requires re-writing the same code each time
2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
Example: When designing a `frontend-webapp-builder` skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
1. Writing a frontend webapp requires the same boilerplate HTML/React each time
2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
1. Querying BigQuery requires re-discovering the table schemas and relationships each time
2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
**For Claude Code plugins:** When building a hooks skill, the analysis shows:
1. Developers repeatedly need to validate hooks.json and test hook scripts
2. `scripts/validate-hook-schema.sh` and `scripts/test-hook.sh` utilities would be helpful
3. `references/patterns.md` for detailed hook patterns to avoid bloating SKILL.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.
### Step 3: Create Skill Structure
For Claude Code plugins, create the skill directory structure:
```bash
mkdir -p plugin-name/skills/skill-name/{references,examples,scripts}
touch plugin-name/skills/skill-name/SKILL.md
```
**Note:** Unlike the generic skill-creator which uses `init_skill.py`, plugin skills are created directly in the plugin's `skills/` directory with a simpler manual structure.
### Step 4: Edit the Skill
When editing the (newly-created 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.
#### Start with Reusable Skill Contents
To begin implementation, start with the reusable resources identified above: `scripts/`, `references/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `references/`.
Also, delete any example files and directories not needed for the skill. Create only the directories you actually need (references/, examples/, scripts/).
#### Update 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.
**Description (Frontmatter):** Use third-person format with specific trigger phrases:
```yaml
---
name: Skill Name
description: This skill should be used when the user asks to "specific phrase 1", "specific phrase 2", "specific phrase 3". Include exact phrases users would say that should trigger this skill. Be concrete and specific.
version: 0.1.0
---
```
**Good description examples:**
```yaml
description: This skill should be used when the user asks to "create a hook", "add a PreToolUse hook", "validate tool use", "implement prompt-based hooks", or mentions hook events (PreToolUse, PostToolUse, Stop).
```
**Bad description examples:**
```yaml
description: Use this skill when working with hooks. # Wrong person, vague
description: Load when user needs hook help. # Not third person
description: Provides hook guidance. # No trigger phrases
```
To complete SKILL.md body, answer the following questions:
1. What is the purpose of the skill, in a few sentences?
2. When should the skill be used? (Include this in frontmatter description with specific triggers)
3. 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.
**Keep SKILL.md lean:** Target 1,500-2,000 words for the body. Move detailed content to references/:
- Detailed patterns → `references/patterns.md`
- Advanced techniques → `references/advanced.md`
- Migration guides → `references/migration.md`
- API references → `references/api-reference.md`
**Reference resources in SKILL.md:**
```markdown
## Additional Resources
### Reference Files
For detailed patterns and techniques, consult:
- **`references/patterns.md`** - Common patterns
- **`references/advanced.md`** - Advanced use cases
### Example Files
Working examples in `examples/`:
- **`example-script.sh`** - Working example
```
### Step 5: Validate and Test
**For plugin skills, validation is different from generic skills:**
1. **Check structure**: Skill directory in `plugin-name/skills/skill-name/`
2. **Validate SKILL.md**: Has frontmatter with name and description
3. **Check trigger phrases**: Description includes specific user queries
4. **Verify writing style**: Body uses imperative/infinitive form, not second person
5. **Test progressive disclosure**: SKILL.md is lean (~1,500-2,000 words), detailed content in references/
6. **Check references**: All referenced files exist
7. **Validate examples**: Examples are complete and correct
8. **Test scripts**: Scripts are executable and work correctly
**Use the skill-reviewer agent:**
```
Ask: "Review my skill and check if it follows best practices"
```
The skill-reviewer agent will check description quality, content organization, and progressive disclosure.
### Step 6: Iterate
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:**
1. Use the skill on real tasks
2. Notice struggles or inefficiencies
3. Identify how SKILL.md or bundled resources should be updated
4. Implement changes and test again
**Common improvements:**
- Strengthen trigger phrases in description
- Move long sections from SKILL.md to references/
- Add missing examples or scripts
- Clarify ambiguous instructions
- Add edge case handling
## Plugin-Specific Considerations
### Skill Location in Plugins
Plugin skills live in the plugin's `skills/` directory:
```
my-plugin/
├── .claude-plugin/
│ └── plugin.json
├── commands/
├── agents/
└── skills/
└── my-skill/
├── SKILL.md
├── references/
├── examples/
└── scripts/
```
### Auto-Discovery
Claude Code automatically discovers skills:
- Scans `skills/` directory
- Finds subdirectories containing `SKILL.md`
- Loads skill metadata (name + description) always
- Loads SKILL.md body when skill triggers
- Loads references/examples when needed
### No Packaging Needed
Plugin skills are distributed as part of the plugin, not as separate ZIP files. Users get skills when they install the plugin.
### Testing in Plugins
Test skills by installing plugin locally:
```bash
# Test with --plugin-dir
cc --plugin-dir /path/to/plugin
# Ask questions that should trigger the skill
# Verify skill loads correctly
```
## Examples from Plugin-Dev
Study the skills in this plugin as examples of best practices:
**hook-development skill:**
- Excellent trigger phrases: "create a hook", "add a PreToolUse hook", etc.
- Lean SKILL.md (1,651 words)
- 3 references/ files for detailed content
- 3 examples/ of working hooks
- 3 scripts/ utilities
**agent-development skill:**
- Strong triggers: "create an agent", "agent frontmatter", etc.
- Focused SKILL.md (1,438 words)
- References include the AI generation prompt from Claude Code
- Complete agent examples
**plugin-settings skill:**
- Specific triggers: "plugin settings", ".local.md files", "YAML frontmatter"
- References show real implementations (multi-agent-swarm, ralph-wiggum)
- Working parsing scripts
Each demonstrates progressive disclosure and strong triggering.
## Progressive Disclosure in Practice
### What Goes in SKILL.md
**Include (always loaded when skill triggers):**
- Core concepts and overview
- Essential procedures and workflows
- Quick reference tables
- Pointers to references/examples/scripts
- Most common use cases
**Keep under 3,000 words, ideally 1,500-2,000 words**
### What Goes in references/
**Move to references/ (loaded as needed):**
- Detailed patterns and advanced techniques
- Comprehensive API documentation
- Migration guides
- Edge cases and troubleshooting
- Extensive examples and walkthroughs
**Each reference file can be large (2,000-5,000+ words)**
### What Goes in examples/
**Working code examples:**
- Complete, runnable scripts
- Configuration files
- Template files
- Real-world usage examples
**Users can copy and adapt these directly**
### What Goes in scripts/
**Utility scripts:**
- Validation tools
- Testing helpers
- Parsing utilities
- Automation scripts
**Should be executable and documented**
## Writing Style Requirements
### Imperative/Infinitive Form
Write using verb-first instructions, not second person:
**Correct (imperative):**
```
To create a hook, define the event type.
Configure the MCP server with authentication.
Validate settings before use.
```
**Incorrect (second person):**
```
You should create a hook by defining the event type.
You need to configure the MCP server.
You must validate settings before use.
```
### Third-Person in Description
The frontmatter description must use third person:
**Correct:**
```yaml
description: This skill should be used when the user asks to "create X", "configure Y"...
```
**Incorrect:**
```yaml
description: Use this skill when you want to create X...
description: Load this skill when user asks...
```
### Objective, Instructional Language
Focus on what to do, not who should do it:
**Correct:**
```
Parse the frontmatter using sed.
Extract fields with grep.
Validate values before use.
```
**Incorrect:**
```
You can parse the frontmatter...
Claude should extract fields...
The user might validate values...
```
## Validation Checklist
Before finalizing a skill:
**Structure:**
- [ ] SKILL.md file exists with valid YAML frontmatter
- [ ] Frontmatter has `name` and `description` fields
- [ ] Markdown body is present and substantial
- [ ] Referenced files actually exist
**Description Quality:**
- [ ] Uses third person ("This skill should be used when...")
- [ ] Includes specific trigger phrases users would say
- [ ] Lists concrete scenarios ("create X", "configure Y")
- [ ] Not vague or generic
**Content Quality:**
- [ ] SKILL.md body uses imperative/infinitive form
- [ ] Body is focused and lean (1,500-2,000 words ideal, <5k max)
- [ ] Detailed content moved to references/
- [ ] Examples are complete and working
- [ ] Scripts are executable and documented
**Progressive Disclosure:**
- [ ] Core concepts in SKILL.md
- [ ] Detailed docs in references/
- [ ] Working code in examples/
- [ ] Utilities in scripts/
- [ ] SKILL.md references these resources
**Testing:**
- [ ] Skill triggers on expected user queries
- [ ] Content is helpful for intended tasks
- [ ] No duplicated information across files
- [ ] References load when needed
## Common Mistakes to Avoid
### Mistake 1: Weak Trigger Description
❌ **Bad:**
```yaml
description: Provides guidance for working with hooks.
```
**Why bad:** Vague, no specific trigger phrases, not third person
✅ **Good:**
```yaml
description: This skill should be used when the user asks to "create a hook", "add a PreToolUse hook", "validate tool use", or mentions hook events. Provides comprehensive hooks API guidance.
```
**Why good:** Third person, specific phrases, concrete scenarios
### Mistake 2: Too Much in SKILL.md
❌ **Bad:**
```
skill-name/
└── SKILL.md (8,000 words - everything in one file)
```
**Why bad:** Bloats context when skill loads, detailed content always loaded
✅ **Good:**
```
skill-name/
├── SKILL.md (1,800 words - core essentials)
└── references/
├── patterns.md (2,500 words)
└── advanced.md (3,700 words)
```
**Why good:** Progressive disclosure, detailed content loaded only when needed
### Mistake 3: Second Person Writing
❌ **Bad:**
```markdown
You should start by reading the configuration file.
You need to validate the input.
You can use the grep tool to search.
```
**Why bad:** Second person, not imperative form
✅ **Good:**
```markdown
Start by reading the configuration file.
Validate the input before processing.
Use the grep tool to search for patterns.
```
**Why good:** Imperative form, direct instructions
### Mistake 4: Missing Resource References
❌ **Bad:**
```markdown
# SKILL.md
[Core content]
[No mention of references/ or examples/]
```
**Why bad:** Claude doesn't know references exist
✅ **Good:**
```markdown
# SKILL.md
[Core content]
## Additional Resources
### Reference Files
- **`references/patterns.md`** - Detailed patterns
- **`references/advanced.md`** - Advanced techniques
### Examples
- **`examples/script.sh`** - Working example
```
**Why good:** Claude knows where to find additional information
## Quick Reference
### Minimal Skill
```
skill-name/
└── SKILL.md
```
Good for: Simple knowledge, no complex resources needed
### Standard Skill (Recommended)
```
skill-name/
├── SKILL.md
├── references/
│ └── detailed-guide.md
└── examples/
└── working-example.sh
```
Good for: Most plugin skills with detailed documentation
### Complete Skill
```
skill-name/
├── SKILL.md
├── references/
│ ├── patterns.md
│ └── advanced.md
├── examples/
│ ├── example1.sh
│ └── example2.json
└── scripts/
└── validate.sh
```
Good for: Complex domains with validation utilities
## Best Practices Summary
✅ **DO:**
- Use third-person in description ("This skill should be used when...")
- Include specific trigger phrases ("create X", "configure Y")
- Keep SKILL.md lean (1,500-2,000 words)
- Use progressive disclosure (move details to references/)
- Write in imperative/infinitive form
- Reference supporting files clearly
- Provide working examples
- Create utility scripts for common operations
- Study plugin-dev's skills as templates
❌ **DON'T:**
- Use second person anywhere
- Have vague trigger conditions
- Put everything in SKILL.md (>3,000 words without references/)
- Write in second person ("You should...")
- Leave resources unreferenced
- Include broken or incomplete examples
- Skip validation
## Additional Resources
### Study These Skills
Plugin-dev's skills demonstrate best practices:
- `../hook-development/` - Progressive disclosure, utilities
- `../agent-development/` - AI-assisted creation, references
- `../mcp-integration/` - Comprehensive references
- `../plugin-settings/` - Real-world examples
- `../command-development/` - Clear critical concepts
- `../plugin-structure/` - Good organization
### Reference Files
For complete skill-creator methodology:
- **`references/skill-creator-original.md`** - Full original skill-creator content
## Implementation Workflow
To create a skill for your plugin:
1. **Understand use cases**: Identify concrete examples of skill usage
2. **Plan resources**: Determine what scripts/references/examples needed
3. **Create structure**: `mkdir -p skills/skill-name/{references,examples,scripts}`
4. **Write SKILL.md**:
- Frontmatter with third-person description and trigger phrases
- Lean body (1,500-2,000 words) in imperative form
- Reference supporting files
5. **Add resources**: Create references/, examples/, scripts/ as needed
6. **Validate**: Check description, writing style, organization
7. **Test**: Verify skill loads on expected triggers
8. **Iterate**: Improve based on usage
Focus on strong trigger descriptions, progressive disclosure, and imperative writing style for effective skills that load when needed and provide targeted guidance.
按说明文件中的顺序排列。
关于技能
提供什么技能
技能剖析
渐进式披露设计原则
技能创造过程
文件/命令 -> name · description · scripts/ · scripts/rotate_pdf.py · references/ · references/finance.md · references/mnda.md · references/policies.md
内容校验值 -> 2dee576a2199
当前原文的自动摘译,尚未人工审校。
关于技能
技能是模块化、独立的包,通过提供专业知识、工作流程和工具来扩展 Claude 的能力。将它们视为特定领域或任务的“入门指南”——它们将 Claude 从通用智能体转变为配备了任何模型都无法完全拥有的程序知识的专业智能体。
提供什么技能
专业工作流程 - 针对特定领域的多步骤过程 工具集成 - 使用特定文件格式或 API 的说明 领域专业知识 - 公司特定的知识、模式、业务逻辑 捆绑资源 - 用于复杂和重复任务的脚本、参考和资产
技能剖析
每个技能都包含必需的 SKILL.md 文件和可选的捆绑资源: SKILL.md(必需) 元数据质量:YAML frontmatter 中的
name和description决定 Claude 何时使用该技能。具体说明该技能的作用以及何时使用它。使用第三人称(例如“该技能应在...时使用”而不是“在...时使用该技能”)。捆绑资源(可选) 脚本 (scripts/)渐进式披露设计原则
技能使用三级加载系统来有效管理上下文: 元数据(名称 + 描述) - 始终在上下文中(~100 个单词) SKILL.md 主体 - 当技能触发时(<5k 个单词) 捆绑资源 - 根据 Claude 的需要(无限制*) *无限制,因为可以在不读入上下文窗口的情况下执行脚本。
技能创造过程
要创建技能,请按顺序遵循“技能创建流程”,仅当有明确原因不适用时才跳过步骤。