10x Documentation
Rules for producing clear, accurate, and maintainable documentation.
Style — Global Rules
These apply to all output: changelogs, READMEs, code comments, ADRs, API docs.
Never use:
- Em dashes (
—). Use a comma, a colon, or rewrite the sentence. - Emojis anywhere.
- Numbered lists unless the order is strictly required (installation steps, migration sequences). Use plain bullet lists otherwise.
- Filler phrases: "successfully", "comprehensive", "seamlessly", "levera
[Description truncada. Veja o README completo no GitHub.]