Skip to content

docs: clarify that When to Use section is required for skills#11

Open
raphaelsamy-quantumlends wants to merge 1 commit intoobra:mainfrom
raphaelsamy-quantumlends:fix/skill-when-to-use-docs
Open

docs: clarify that When to Use section is required for skills#11
raphaelsamy-quantumlends wants to merge 1 commit intoobra:mainfrom
raphaelsamy-quantumlends:fix/skill-when-to-use-docs

Conversation

@raphaelsamy-quantumlends

Summary

  • The skill template in plugin-structure.md showed the ## When to Use section but didn't explain why it matters or that it's required
  • Without this guidance, skill authors include the description frontmatter but skip the body section, which degrades skill discovery and activation
  • Added explanation of the two-layer discovery mechanism: description for filtering, When to Use for confirmation

Context

Ran into this firsthand — created a skill using this plugin's guidance, included a good description frontmatter, but omitted the ## When to Use body section because nothing indicated it was required. The skill loaded but didn't activate reliably until the body section was added.

Test plan

  • Verify the template example in plugin-structure.md is clear
  • Confirm new skills created following this guidance include both discovery mechanisms

🤖 Generated with Claude Code

The skill template in plugin-structure.md showed the ## When to Use
section but didn't explain why it matters. Without explicit guidance,
skill authors may include the description frontmatter but skip the
body section, degrading skill discovery and activation.

Added explanation of the two-layer discovery mechanism (description
for filtering, When to Use for confirmation) and marked both as
required.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant