What problem does it solve?
Developer documentation is often vague, inaccurate, or sounds machine-generated, causing readers to misread procedures or distrust the content. This Skill produces documentation grounded in the repository's real symbols, paths, and commands, written in plain sentences that readers understand on the first pass.
Core Features & Use Cases
- Document mode selection: Classifies content as tutorial, how-to guide, reference, or explanation using the Diataxis-style framework in references/document-modes.md, so each document serves one clear reader need.
- Sentence-level editing: Applies the rules in references/sentence-style.md to remove filler, vague claims, chatbot phrasing, and ambiguous pronouns while preserving precise domain terminology.
- Verification against source: Checks every named symbol, path, flag, command, and expected result against the actual codebase before publishing claims.
- Use Case: Ask it to improve a project README; it reads the repository, rewrites the setup steps to match the real commands, and removes generated-sounding prose.
Quick Start
Ask the assistant to use the prp-technical-writing skill to review and rewrite your project's README.md based on the actual code in the repository.
