The documentation handbook

The practices behind every project we ship. Read it top to bottom, or press ⌘K to jump straight to an answer.

Start here

How our writers plan, structure and write documentation that people can follow.

Find out who you're writing for, then write so they get it right on the first read.

Voice, structure and word choices that make technical content easy to read.

The anatomy of an endpoint page, and how to keep it in sync with your OpenAPI spec.

Write release notes that explain what changed and why it matters to the reader.

Four page types that keep a documentation site navigable as it grows.

A repository layout and pull-request flow that keeps writers and engineers in one loop.

Automated checks for style, links and code samples so docs stay correct.

Static rendering, instant search and Core Web Vitals budgets for documentation sites.