What problem does it solve?
Documentation often drifts from a team's established voice and style rules, and manually reviewing prose for hedging, passive voice, banned punctuation, and inconsistent terminology is slow and error-prone. This Skill audits docs, guides, READMEs, or prose against the good-docs-writing style guide and produces a structured findings report without editing files unless asked.
Core Features & Use Cases
- Rule-based auditing: Checks prose against a prioritized 12-item violation checklist covering hedging, passive voice, marketing fluff, em-dashes, terminology, and code formatting.
- Structured findings report: Outputs findings grouped by severity (high, medium, low) with file:line citations, exact offending text, and concrete rewrites mapped to style-guide categories.
- Report-only by default: Never modifies files unless the user explicitly asks for fixes, making it safe for review workflows.
- Use Case: A technical writer asks to lint a README before release; the Skill reads the style guide, walks each rule category, and returns a report like "README.md:42 · [Punctuation] Em-dash banned" with a suggested rewrite for every finding.
Quick Start
Audit the file docs/getting-started.md against the good-docs-writing style guide and report all voice and tone violations with suggested rewrites.
