Section 01 of 04

Style Guide

The decisions behind voice, tone, formatting, naming, and code examples. Apply these from the first draft — retrofitting style is expensive.


4 documents in this section

Voice and Tone

Defines who you are as a communicator (voice — consistent) and how you adjust to context (tone — variable). Covers formal vs. conversational registers and prohibited patterns.

Read guide
Formatting Standards

Heading hierarchy, list construction, table usage, callout types, and visual layout conventions. Reduces cognitive load by making all docs look and behave the same way.

Read guide
Naming Conventions

Consistent rules for UI text, page headings, API field references, and code identifiers. Reduces ambiguity and helps users build accurate mental models of the product.

Read guide
Code Examples

Standards for writing, formatting, and maintaining code samples. Code examples are often the most-read part of developer docs — a bad example costs the user time and erodes trust.

Read guide