Back to list
Windsage63

skill-best-practices

by Windsage63

0🍴 0📅 Jan 16, 2026

SKILL.md


name: skill-best-practices description: "Guides creation of Anthropic-compliant Claude skills. Triggers on: create skill, new skill, skill guidelines, skill best practices, write a skill."

Skill Best Practices

Build Claude skills that follow Anthropic's official guidelines for discovery, structure, and progressive disclosure.

Table of Contents

  1. The Job
  2. Quick Reference
  3. Frontmatter Rules
  4. Body Content Rules
  5. Progressive Disclosure
  6. Checklist

The Job

  1. Review the skill's purpose and triggers with the user
  2. Create skill folder: .github/skills/[skill-name]/
  3. Write SKILL.md with compliant frontmatter and body
  4. Extract large examples/schemas to references/ if needed
  5. Verify line count and structure

Quick Reference

ElementConstraint
nameMax 64 chars, lowercase letters/numbers/hyphens only
descriptionMax 200 chars recommended, include trigger phrases
Body lengthUnder 500 lines / 5,000 words
TOC requiredFiles over 100 lines
Reference nestingMax 1 level deep from SKILL.md

Frontmatter Rules

Every skill requires YAML frontmatter with name and description.

Name Field

  • Max 64 characters
  • Lowercase only — no uppercase letters
  • Allowed: letters, numbers, hyphens
  • Forbidden: XML tags, reserved words ("anthropic", "claude")
  • Must match the folder name

Description Field

  • Max 200 characters (recommended for efficient discovery)
  • Third-person voice — injected into system prompt
  • Include trigger keywords at the end
  • Focus: What the skill does + when to use it

Pattern:

"[What it does in one sentence]. Triggers on: [keyword 1], [keyword 2], [keyword 3]."

Example:

description: "Generates PRDs with user stories and acceptance criteria. Triggers on: create prd, plan feature, write requirements."

See references/frontmatter_spec.md for full specification.


Body Content Rules

Conciseness Principles

  • Assume Claude is smart — only add novel context
  • Question every line — does this justify its token cost?
  • No duplication — information in one place only
  • Examples over explanations — show, don't tell

Structure Requirements

  • Under 500 lines / 5,000 words
  • Add TOC for files over 100 lines
  • Clear workflow — numbered steps preferred
  • Stopping rules — explicit "don't do X" section
  • Completion checklist — verification steps

See references/body_guidelines.md for detailed patterns.


Progressive Disclosure

Claude loads content in three levels:

  1. Metadata (always loaded): name + description (~100 tokens)
  2. SKILL.md body (on trigger): Full instructions (up to 5,000 words)
  3. Reference files (on demand): Loaded only when needed

When to Extract to References

  • Large code examples (50+ lines)
  • Complete output templates
  • Detailed schemas or specifications
  • Variant-specific instructions

File Organization

skill-name/
├── SKILL.md              # Core instructions
└── references/
    ├── example.md        # Large example
    ├── template.md       # Output template
    └── spec.md           # Detailed specification

See references/progressive_disclosure.md for patterns.


Checklist

Before finalizing a skill:

  • Folder name matches name field (lowercase, hyphens)
  • Description under 200 chars with trigger keywords
  • SKILL.md under 500 lines
  • TOC added if over 100 lines
  • Large examples extracted to references/
  • Reference files are 1 level deep (no nesting)
  • Stopping rules clearly defined
  • Completion checklist included

Template

See references/skill_template.md for a ready-to-copy starter template.

Score

Total Score

50/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon