Skip to content

Why we write documentation

Documentation is a source of truth.

Docs is support. Docs is record-keeping. Docs is even marketing, promotion and community building.

… But ultimately, docs exist to help.

Good documentation helps someone do something: our goal for our public-facing docs site is to document how to build with Astro and not how Astro is built.

We write to help a reader accomplish what they came into docs to do (learn, build, verify, upgrade, evaluate, troubleshoot…) and then, as quickly as possible, get out of docs and back to their own project.

— Sarah Rainsberger, Astro Docs Lead. From “Stop Writing; Start Helping” presented at ViteConf 2023.