Writing Guidelines

Manage your writing principles and rules

Use an active voice consistently

Voice & Tone

Active voice makes your writing more direct and engaging. It clearly shows who is performing the action.

Instead of 'The report was written by the team' use 'The team wrote the report'

Use specific nouns

Clarity

Specific nouns provide clarity and help readers understand exactly what you're referring to.

Instead of 'vehicle' use 'sedan', 'truck', or 'motorcycle'

Limit exclamation marks

Punctuation

Overuse of exclamation marks can make your writing seem unprofessional or overly emotional.

Use exclamation marks sparingly, only for genuine excitement or emphasis

Check prepositions

Grammar

Incorrect prepositions can confuse readers and make your writing unclear.

Use 'different from' not 'different than', 'comply with' not 'comply to'

Hyphenate modifiers to reduce ambiguity

Grammar

Compound modifiers should be hyphenated when they come before the noun they modify.

Use 'well-known author' not 'well known author'

Double check all pronouns

Grammar

Ensure pronouns have clear antecedents and agree in number and gender.

Make sure 'it', 'they', 'this' clearly refer to specific nouns

Use sentence casing in headers and CTAs

Formatting

Sentence case is more readable and feels more conversational than title case.

Use 'Sign up for updates' not 'Sign Up For Updates'

Make your average sentence 15 words long

Readability

Shorter sentences are easier to read and understand, improving comprehension.

Break long sentences into shorter ones for better readability

Avoid complex sentence structures

Readability

Simple sentence structures are easier to follow and understand.

Avoid multiple dependent clauses and nested phrases

Write at or below a fifth grade reading level

Readability

Simple language ensures your content is accessible to the widest audience.

Use common words instead of complex vocabulary

Use specific, action-oriented present tense verbs

Voice & Tone

Present tense verbs make your writing more immediate and engaging.

Use 'creates' instead of 'will create' or 'has created'

Use consistent terminology

Clarity

Consistent terms help users understand and navigate your content more easily.

If you call it 'dashboard' once, don't call it 'control panel' later

Use contractions

Voice & Tone

Contractions make your writing sound more natural and conversational.

Use 'don't' instead of 'do not', 'we'll' instead of 'we will'

Apply progressive disclosure

Structure

Present information in digestible chunks, revealing details progressively.

Start with overview, then provide details when users need them

Write in present tense

Voice & Tone

Present tense makes instructions and descriptions more immediate and clear.

Use 'Click the button' not 'You will click the button'

Avoid using a disparaging or condescending tone

Voice & Tone

Respectful language creates a better user experience and builds trust.

Avoid phrases like 'Obviously' or 'Simply' that might make users feel inadequate

Avoid using jargon

Clarity

Technical jargon can confuse users who aren't familiar with industry terms.

Use 'settings' instead of 'configuration parameters'

Avoid double negatives

Clarity

Double negatives are confusing and harder to process than positive statements.

Use 'Remember to save' instead of 'Don't forget to not lose your work'