From ai-devkit
Reviews documentation from a novice user's perspective, rating clarity, completeness, actionability, and structure. Outputs prioritized issues and concrete suggested fixes.
How this skill is triggered — by the user, by Claude, or both
Slash command
/ai-devkit:technical-writerThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Review documentation as a novice would experience it. Suggest concrete improvements.
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
npx claudepluginhub codeaholicguy/ai-devkitWrites and audits technical documentation, API docs, user guides, and specifications for completeness, sequence, precision, and audience calibration.
Improves technical docs in-place via phased Audit → Research → Rewrite → Validate workflow. Calls docs-review for scoring; applies rubric-defined formatting rules.
Reviews documentation completeness, accuracy, and audience-appropriateness against a project's inferred norms rather than an idealized checklist.