Comprehensive checklist and process for reviewing documentation quality including voice, tone, structure, completeness, and technical accuracy.
/plugin marketplace add lerianstudio/ring/plugin install ring-tw-team@ringThis skill inherits all available tools. When active, it can use any tool Claude has access to.
Review documentation systematically across multiple dimensions. A thorough review catches issues before they reach users.
| Check | Flag If |
|---|---|
| Second person | "Users can..." instead of "You can..." |
| Present tense | "will return" instead of "returns" |
| Active voice | "is returned by the API" instead of "The API returns" |
| Tone | Arrogant ("Obviously...") or condescending |
| Check | Flag If |
|---|---|
| Hierarchy | Deep nesting (H4+), unclear parent-child |
| Headings | Title Case instead of sentence case |
| Section dividers | Missing --- between major topics |
| Navigation | Missing links to related content |
Conceptual docs: Definition, characteristics, how it works, related concepts, next steps
How-to guides: Prerequisites, all steps, verification, troubleshooting, next steps
API docs: HTTP method/path, all parameters, all fields, required vs optional, examples, error codes
| Check | Flag If |
|---|---|
| Sentence length | >25 words per sentence |
| Paragraph length | >3 sentences per paragraph |
| Jargon | Technical terms not explained on first use |
| Examples | Abstract data ("foo", "bar") instead of realistic |
Conceptual: Facts correct, behavior matches description, links work
API docs: Paths correct, methods correct, field names match API, types accurate, examples valid JSON
Code examples: Compiles/runs, output matches description, no syntax errors
| Category | Issue | Fix |
|---|---|---|
| Voice | Third person ("Users can...") | "You can..." |
| Voice | Passive ("...is returned") | "...returns" |
| Voice | Future tense ("will provide") | "provides" |
| Structure | Title case heading | Sentence case |
| Structure | Wall of text | Add --- dividers |
| Completeness | Missing prereqs | Add prerequisites |
| Completeness | No examples | Add code examples |
| Clarity | Long sentences (40+ words) | Split into multiple |
| Clarity | Undefined jargon | Define on first use |
Note: Documentation reviews use
PASS/NEEDS_REVISION/MAJOR_ISSUESverdicts (graduated), which differ from code review verdicts (PASS/FAIL/NEEDS_DISCUSSION).
## Review Summary
**Overall Assessment:** [PASS | NEEDS_REVISION | MAJOR_ISSUES]
### Issues Found
#### High Priority
1. **Line 45:** Passive voice "is created by" → "creates"
#### Medium Priority
1. **Line 23:** Title case in heading → sentence case
#### Low Priority
1. **Line 12:** Could add example for clarity
### Recommendations
1. Fix passive voice instances (3 found)
2. Add missing API field documentation
Voice (30s): "You" not "users", present tense, active voice
Structure (30s): Sentence case headings, section dividers, scannable (bullets/tables)
Completeness (1m): Examples present, links work, next steps included
Accuracy (varies): Technical facts correct, code examples work
This skill should be used when the user asks about libraries, frameworks, API references, or needs code examples. Activates for setup questions, code generation involving libraries, or mentions of specific frameworks like React, Vue, Next.js, Prisma, Supabase, etc.
Applies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.
Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems. Create original algorithmic art rather than copying existing artists' work to avoid copyright violations.