documentationlisted
Install: claude install-skill stijnvanhulle/agents
# Documentation skill
Writing guidelines for AI coding assistants working on documentation.
## When to use
- Adding a new plugin, feature, or option
- Changing plugin behavior or API signatures
- Fixing bugs that affect code generation
- Writing or updating functionalities/component/composable documentation
- Optimizing documentation for search engines
## What it does
- Write clear, practical documentation aimed at the developer reading it
- Match the words developers search for
- Structure content so a reader can skim it and still find the answer
## Writing standard
When writing documentation, keep proper grammar and complete sentences. The "sacrifice grammar
for brevity" rule does not apply here.
Documentation must be:
- Grammatically correct
- Clear and unambiguous
- Properly punctuated
- Complete sentences (not fragments)
Brevity is still valued, but never at the cost of clarity or correctness.
## Available references
| Reference | Purpose |
| --- | --- |
| [references/writing-style.md](./references/writing-style.md) | Voice, tone, sentence structure |
| [references/content-patterns.md](./references/content-patterns.md) | Usage patterns, props structure, component patterns |
| [references/seo-optimization.md](./references/seo-optimization.md) | SEO practices, titles, descriptions, keywords, FAQs |
To remove AI writing patterns and add voice, use the [humanizer](../humanizer/SKILL.md) skill.
Load based on context:
- Writing prose → [references/writing-style.