Technical Writing Styleguide

Quick Reference

Voice: first person plural ("we'll install..."), active voice, friendly and informal tone.

Point of view priority:

1. First person plural to include the reader: "Next, we'll configure the server."
2. Second person imperative for instructions: "Type npm install."

Key rules:

• Be opinionated, not comprehensive — pick one approach and recommend it
• Never tell the reader something is "easy" or "obvious"
• Never start with personal background or definitions
• Avoid marketing speak and encyclopaedia-style content
• Use serial commas, common contractions, and sentence case for headings
• Place inline code between backticks, but use fenced code blocks for any runnable commands
• Put text before screenshots, never two screenshots in a row without text between them