Product Documentation guides
Find the product-documentation pack's workflows for auditing, writing, revising, and verifying the docs of any software product.
These guides help you write and check the docs for a product you ship.
Start here
Section titled “Start here”- Write the docs — Document a shipped feature as a page that matches your code, or find the gaps in a doc set.
- Getting Started with Product Documentation — Audit your repository’s docs and write the first missing page.
- How to author product docs — Audit docs against the reader journey, then create, revise, or verify a page.
- About the Diátaxis framework — The four kinds of page and the job each one does.