Checklist: documentation release readiness
Coverage
Section titled “Coverage”- Every new or changed feature in this release has corresponding documentation.
- Every removed or deprecated feature has its documentation removed or marked deprecated - stale docs for a dead feature are worse than no docs.
- Breaking changes are called out explicitly, not buried in a changelog nobody reads.
Accuracy
Section titled “Accuracy”- Documentation has been tested against a release-candidate build, not an earlier dev build.
- Version numbers, compatibility tables, and system requirements reflect this release.
Translation
Section titled “Translation”- Translated versions are either updated for this release or explicitly flagged as pending - see translation. Don’t ship an English-only update silently under a page that claims to be translated.
Delivery
Section titled “Delivery”- Target formats generate cleanly with no build errors - see target format.
- Links (internal and to the product itself, e.g. a UI path) have been checked against the release-candidate build.
- The delivery channel (site, PDF download, in-product help) is updated, not just the source.
Sign-off
Section titled “Sign-off”- Technical review is complete (see the technical review checklist).
- A named owner has confirmed documentation is ready - a checklist with no accountable sign-off tends not to get run.