Category: Guides
Step-by-step walkthroughs for the documentation tasks that come up most often.
-
Guides
How to Write a Quickstart That Gets Someone to Working Code in Five Minutes
A quickstart has one job: get a reader from nothing to a verified, working result as fast as possible. Everything that does not serve that (background, alternatives, best practice) belongs on another…
-
Guides
How to Structure a Troubleshooting Guide That Actually Resolves Tickets
Organise a troubleshooting guide by symptom, not by subsystem: readers arrive with an error message, not a theory. Here is the anatomy of an entry that resolves a ticket, and how to…
-
Guides
How to Version Your Documentation Without Losing Your Readers
Versioned documentation solves a real problem and creates three new ones: duplicated pages, split search results, and readers who land on a version they are not running. Here is when to version,…
-
Guides
How to Write API Documentation Developers Actually Read
Every endpoint page has to answer four questions: what the call does, what it takes, what it returns, and what happens when it fails. Structure the page around those four and developers…
-
Guides
A WCAG 2.1 AA Checklist for Documentation Sites
Documentation sites fail accessibility in a small and predictable set of places. A working checklist of the WCAG 2.1 AA criteria docs actually trip on, the five failures we see most often,…
