Guides

Short, practical guides on shipping and communicating changes. No fluff, honest examples. · Subscribe via RSS

Prefer feedback over reading? Run the free changelog linter — it grades your CHANGELOG.md against these guides and links the ones you need.

Start here

New to changelogs? Read these five in order — they cover the whole arc from “what is this” to “is it working”.

  1. What is a changelog? A plain-English definition (with examples) — the two-minute definition and what belongs in one
  2. How to write a changelog (with examples) — the craft: structure, examples, and a template
  3. Starting a changelog for an existing product: how far back should you go? — adding one to an existing product (how far back to go)
  4. How to announce a new feature: channels, copy, and timing — getting updates in front of people: channels and timing
  5. Changelog metrics: how to tell if anyone reads your updates — telling whether anyone actually reads it

Writing & craft

Formats & versioning

Automation & workflow

Channels & strategy