Skip to content
Changelog / Release notes

Changelog / Release notes

The dated record of what shipped, written for users rather than for the commit log.

Content & Publishing · 8 checks · 17 resources

Before you ship

8
  1. 01Reverse-chronological entries each with a date and a version or release name
  2. 02Change type labelled per item — new, improved, fixed, deprecated, breaking
  3. 03User-facing language — what changed for the reader, not the internal ticket title
  4. 04Visual evidence for significant changes — a screenshot or short clip of the new behaviour
  5. 05Deep links into the product and into the docs for each substantive entry
  6. 06Breaking changes and deprecations called out separately, with the removal date and a migration path
  7. 07Subscription options — RSS, email, and an in-product 'what's new' badge that clears once read
  8. 08Permalink and filter per entry — so a support reply can link to one specific change, filtered by product area

Resources that help you build this

17