Guides
Writing changelogs, in practice
Guides to writing and running a product changelog: what to write, where to put it, and how to keep it going.
-
Changelog vs release notes vs product updates
Four terms for nearly the same thing. The differences are who the reader is and how the entries are ordered — and once you see that, which one you need is obvious.
2 minute read
-
Release notes templates you can copy and paste
Six templates, each short enough to fill in before the release goes out. Copy one, replace the brackets, delete what does not apply.
3 minute read
-
What is a changelog?
A changelog is a dated, public record of what changed in a product, newest first. Here is what belongs in one, who actually reads it, and the difference between the file developers keep and the page customers see.
2 minute read
-
CHANGELOG.md vs a public changelog page
One is for developers reading a diff, the other for customers deciding whether you are still shipping. Most products need both, and the second can be built from the first.
2 minute read
-
How to write release notes people actually read
Most release notes are written for the person shipping, not the person reading. Here is the shape that gets read, with examples of the same entry written badly and well.
4 minute read
-
How to move your changelog without losing your history
Switching changelog tools usually means abandoning years of entries or re-typing them. It does not have to. Here is the order to do it in, and the two things that go wrong.
3 minute read
Your changelog, on your own domain
One plan at $19 a month: your domain, the widget, subscriber emails, no watermark and no trackers on your readers. Writing is free — a card starts the 7-day trial when you publish.