ring-reviewing-docs

name

ring:reviewing-docs

description

Reviewing end-user and product documentation quality across voice/tone, structure, completeness, clarity, and technical accuracy; flags issues with prioritized findings and a pass/needs-revision verdict. Use when reviewing draft docs, running a pre-publication check, auditing existing docs, or enforcing style-guide compliance. Skip when writing new docs, or checking voice only (use ring:applying-voice-and-tone).

Documentation Review Process

When to use

• Reviewing draft documentation
• Pre-publication quality check
• Documentation audit
• Ensuring style guide compliance

Skip when

• Writing new documentation → dispatch the guide-writer or api-writer agent
• Only checking voice → use ring:applying-voice-and-tone

Sequence

Runs after: guide-writer, api-writer (agents)

Related

Complementary: ring:applying-voice-and-tone, ring:structuring-documentation

Review documentation systematically across multiple dimensions. A thorough review catches issues before they reach users.

Review Dimensions

1. Voice and Tone – Does it sound right?
2. Structure – Is it organized effectively?
3. Completeness – Is everything covered?
4. Clarity – Is it easy to understand?
5. Technical Accuracy – Is it correct?

---

Voice and Tone Review

Check	Flag If
Second person	"Users can..." instead of "You can..."
Present tense	"will return" instead of "returns"