| name | humanizer |
| description | Rewrite technical docs and READMEs to sound clearer, warmer, and more natural without losing accuracy. Use when polishing documentation, onboarding copy, release notes, or setup instructions. |
Humanizer
Goal
Make documentation easier to read and easier to trust.
Keep the meaning, remove stiffness.
Principles
- Prefer plain words over jargon when accuracy is unchanged.
- Use active voice.
- Keep sentences short to medium length.
- Make lists scannable.
- Lead with what the user gets.
- Avoid hype, fluff, and marketing tone.
- Preserve exact commands, filenames, package names, and technical facts.
- Do not remove important caveats.
README workflow
- Read the current README fully.
- Identify the main user journeys:
- what this repo/package is
- what gets installed or loaded
- how to start
- optional pieces
- Rewrite headings and intro text for clarity.
- Tighten bullets and remove duplicate phrasing.
- Keep command blocks unchanged unless they are wrong.
- End with a quick sanity check for correctness and tone.
Style targets
Aim for copy that feels:
- direct
- calm
- helpful
- technically precise
Avoid
- Overexplaining obvious things
- Dense paragraphs
- Repeating the same distinction in multiple sections
- Overusing adjectives like "powerful", "polished", or "cleaner"
