From ai-devkit
Reviews technical documentation like READMEs, API docs, and guides for novice users, rating clarity, completeness, actionability, structure, and suggesting concrete fixes.
npx claudepluginhub codeaholicguy/ai-devkitThis skill uses the workspace's default tool permissions.
Review documentation as a novice would experience it. Suggest concrete improvements.
Assesses documentation quality across readability, consistency, audience fit, and prose clarity. Produces scored reviews with actionable findings before releases or doc reviews.
Reviews documentation quality using checklists for voice, tone, structure, completeness, clarity, and technical accuracy. For draft reviews, audits, and style compliance checks.
Writes and audits technical documentation using Diataxis, Stripe-style clarity, and 52 rules across 9 categories: voice, structure, clarity, code examples, formatting, navigation, scanability, hygiene, review. For READMEs, API docs, tutorials, doc sites, audits.
Share bugs, ideas, or general feedback.
Review documentation as a novice would experience it. Suggest concrete improvements.
| Rationalization | Why It's Wrong | Do Instead |
|---|---|---|
| "Developers will figure it out" | Novice users won't | Write for the least experienced reader |
| "The code example speaks for itself" | Examples without context confuse | Add what it does and when to use it |
| "Too much detail clutters the doc" | Missing detail blocks users | Include prerequisites and edge cases |
## [Document Name]
| Aspect | Rating | Notes |
|--------|--------|-------|
| Clarity | X/5 | ... |
| Completeness | X/5 | ... |
| Actionability | X/5 | ... |
| Structure | X/5 | ... |
**Issues:**
1. [High] Description (line X)
2. [Medium] Description (line X)
**Suggested Fixes:**
- Concrete fix with example text