Writing Style

Standards for voice, tone, structure, and formatting in technical documentation.

Core Principles

Use active voice

❌ DON'T use passive voice

The configuration file should be updated to include the new API key.

✅ DO use active voice

Update the configuration file to include the new API key.

Be concise

❌ DON'T use unnecessary words

In order to successfully complete the installation process...

✅ DO be direct

To install...

Use parallel structure

❌ DON'T mix structures

The system handles authentication, validates input, and to process payments.

✅ DO use parallel structure

The system authenticates users, validates input, and processes payments.

Lead with the point

❌ DON'T bury the lede

Over the past decade, remote work has transformed how teams collaborate. Companies have experimented... [finally the point]

✅ DO state the point first

Remote work succeeds when teams establish clear communication rhythms. Here's how...

Formatting Standards

• Use proper heading hierarchy
• Use sentence case for headings