For Technical Writer / Documentation Specialists ·
What you'll accomplish
Paste a document, get back every style violation (inconsistent terms, passive voice, deprecated product names) in under a minute. This guide configures Claude as a documentation reviewer that knows your company's style guide, so you stop hunting for inconsistencies by hand.
What you'll need
Before opening Claude, collect the most important parts of your style guide:
What you should see: A focused list of your most important rules, the ones you catch yourself enforcing repeatedly. Troubleshooting: If you don't have a formal style guide, start with your terminology list and your top 5 style preferences.
You are a documentation reviewer for [Company Name]. Your job is to review technical documentation for style guide compliance.
Our terminology rules:
- Use "user ID" not "username" or "user name"
- Use "click" not "press" or "select" (for button interactions)
- Use "navigate to" not "go to" for navigation instructions
- Use "[Product Name]" not "[old product name]" (deprecated)
Our style rules:
- Use active voice (flag passive voice constructions)
- Second person ("you") for instructions, not third person
- Oxford comma required
- Title case for H1 headings, sentence case for H2+
When reviewing a document, return:
1. A list of terminology violations with the incorrect term, location (quote the sentence), and the correct term
2. A list of style violations
3. An overall count of issues found
What you should see: Your project with instructions saved, ready to use for document reviews.
What you should see: Your glossary appears as an uploaded reference in the project.
What you should see: A structured list of violations. Something like:
Terminology violations found: 3
1. "username" → should be "user ID" (found in: "Enter your username in the login field")
2. "press the button" → should be "click the button" (found in: "Press the Submit button to continue")
...
Troubleshooting: If Claude returns too many minor issues, add "Focus only on violations that affect professional quality and reader comprehension, skip minor style preferences" to your instructions.
Create a repeatable process:
What you should see: A review workflow that takes 2-3 minutes instead of 20-30 minutes of manual scanning.
Full style review:
Review this documentation for style guide compliance. Flag: (1) terminology violations per our style guide, (2) passive voice in procedural steps, (3) any deprecated product names. Quote each flagged sentence. [paste document]
Terminology-only check:
Scan this document only for terminology inconsistencies. Is our product referred to by consistent names? Are user interface elements described with consistent verbs? Return violations only. [paste document]
Quick tone check:
Is this documentation written consistently in second person ("you")? Flag any sentences using third person or passive voice. [paste document]
Before/after comparison:
Compare these two versions of the same section. Which is more consistent with: active voice, second person, plain language? [paste version A] --- [paste version B]
Readability check:
Review this documentation for readability. Flag: sentences over 25 words, jargon that's not defined, and any terms that might confuse a non-technical reader. [paste document]