Skill Development Limited info

example-skill

Example Skill is a reference template that shows the structure, frontmatter, and writing conventions for Claude Code plugin skills. It activates when a user asks to demonstrate skills, see the skill format, create a skill template, or discuss skill development patterns.

  • 37.6k GitHub stars
example-skill — illustration

What it is

Example Skill (version 1.0.0) is a demonstration skill that ships in the official example-plugin. It shows the structure and format of Claude Code plugin skills. Its description tells Claude to use it when the user asks to "demonstrate skills", "show skill format", "create a skill template", or discusses skill development patterns. It covers three areas: creating or understanding plugin skills, skill template or reference needs, and skill development patterns. The skill explains that skills are model-invoked capabilities. Claude uses them on its own based on the context of the task. Commands work differently because the user invokes them, and agents are spawned by Claude. Skills instead provide contextual guidance that Claude folds into its responses. The template sets out the file layout. The only required file is SKILL.md inside skills/skill-name/. Optional supporting files are a README.md for extra documentation, a references/ directory (for example patterns.md), an examples/ directory (for example sample.md), and a scripts/ directory for helper scripts (for example helper.sh). Four frontmatter fields are documented. The name (skill identifier) and description (trigger conditions) are required. The version (semantic version number) and license (license information or reference) are optional. The skill stresses that the description field is crucial because it tells Claude when to invoke the skill. A good description includes specific trigger phrases users might say, keywords that signal relevance, and the topic areas the skill covers. The skill also lists content guidelines: a clear purpose, conditions for when to use it, structured guidance, actionable instructions, and practical examples where helpful. It closes with best practices for keeping skills focused and making sure they trigger correctly.

Who it's for

  • Developers creating Claude Code plugin skills
  • Users who want to understand how plugin skills are structured and formatted
  • Anyone looking for a skill template or reference for skill development patterns

Requirements

Requirements

  • A SKILL.md file inside a skills/skill-name/ directory (the main skill definition, required)
  • Frontmatter with the required fields: name (skill identifier) and description (trigger conditions)

هاد السكيل هو قالب مرجعي بيوريك كيف بتنبنى سكيلز البلَغِنز بـ Claude Code، من ترتيب الملفات للـ frontmatter لطريقة كتابة الوصف. بيشتغل لما تطلب تشوف شكل السكيل أو تعمل قالب لسكيل أو تحكي عن طرق تطوير السكيلز.

Examples

Trigger phrase that activates the skill

Prompt
prompt
create a skill template

Expected output: This is one of the trigger phrases in the skill's description. Asking for it prompts Claude to use this skill as a reference.

Good description pattern

yaml
yaml
description: This skill should be used when the user asks to "specific phrase", "another phrase", mentions "keyword", or discusses topic-area.

What it does: This is the recommended pattern for the description frontmatter field. It combines specific trigger phrases, keywords, and topic areas so Claude knows when to invoke the skill.

Required file structure

text
text
skills/
└── skill-name/
    └── SKILL.md          # Main skill definition (required)

What it does: This is the minimal layout for a skill: a single SKILL.md inside a named skill directory.

Optional supporting files structure

text
text
skills/
└── skill-name/
    ├── SKILL.md          # Main skill definition
    ├── README.md         # Additional documentation
    ├── references/       # Reference materials
    │   └── patterns.md
    ├── examples/         # Example files
    │   └── sample.md
    └── scripts/          # Helper scripts
        └── helper.sh

What it does: This is a fuller layout with additional documentation, reference materials, example files, and helper scripts alongside SKILL.md.