24 lines
824 B
Markdown
24 lines
824 B
Markdown
|
# Writing Descriptions
|
||
|
|
|
||
|
|
Short guidance for description fields on skills, agents, commands, and plugins.
|
||
|
|
|
||
|
|
## Formula
|
||
|
|
|
||
|
|
`[Action verb] [what]. [Unambiguous trigger].`
|
||
|
|
|
||
|
|
- Action verb (Build, Generate, Create, Run)
|
||
|
|
- What it does (2-5 words)
|
||
|
|
- Trigger that prevents an "escape hatch" — a reader should not be able to
|
||
|
|
rationalize skipping the tool while still doing the task it covers.
|
||
|
|
|
||
|
|
Examples:
|
||
|
|
- skill: `Build Claude Code skills. Use when creating a skill.`
|
||
|
|
- agent: `Review code against implementation plan. Use after completing a major project step.`
|
||
|
|
- command: `Stage and commit changes. Use when ready to commit.`
|
||
|
|
|
||
|
|
## Full process
|
||
|
|
|
||
|
|
For the complete drafting process (reading the formula reference, the
|
||
|
|
escape-hatch test, and how to return the result), run:
|
||
|
|
→ `${CLAUDE_PLUGIN_ROOT}/workflows/generate-description.md`
|