Changelog and release notes
In technical teams the changelog is the full list of changes in each version, written for developers, and release notes are the summary for users.
In business products both names are used for the same thing, the updates page.
Why it matters
Every change a customer discovers alone is a support request or an unpleasant surprise.
Release notes reduce both, and they also show whoever pays that the product is moving. A customer who sees nothing new for months starts to wonder why they keep paying.
What an entry contains
A release-notes entry contains five things, and the second is what makes it useful.
- The date and, where it applies, the version number.
- What the customer can now do that they could not before.
- Who it affects, by plan or by feature.
- What the customer has to do, if anything.
- An image or a link to the documentation.
Types of change
Changes are usually grouped into four types.
- New. Features that did not exist.
- Improved. Changes to something that already existed.
- Fixed. Bugs resolved.
- Action required. Whatever stops working the same way and makes the customer do something.
What does not belong in release notes
Internal changes customers do not notice do not belong, and neither does a price rise or a change of terms.
Those are communicated separately, in advance and directly to whoever is affected.
Where to publish them
Release notes go on a page of their own and are taken to where customers already are.
Inside the product, in a regular email and, for support, as an internal heads-up before the change reaches customers.
