How to keep a great changelog

Although primarily aimed at open source software, Keep A Changelog has an awesome list of guiding principles to keep a good changelog, most of which apply to product changelogs too:

Note: we baked all of these into Changefeed, so you are keeping a good changelog out of the box.

Even though all of these are important, what makes a great changelog is what it includes and, just as vital, what it excludes.

What Should Go In The Changelog?

As the first priciple states, changelogs are for humans. Specifically, your changelog is for your users, so it should contain all the changes that could affect some of them. Corollary, it should not contain anything that will not affect any of them.

Let's look at some examples:

If you are unsure if a change will affect any of your users, err on the side of including it. As long as your individual entries are concise, they are easy to filter visually.

How To Write Good Changelog Entries

After years of keeping changelogs, we also have some best practices for writing the individual entries:

Ready to kick off your changelog? Get started with Changefeed and publish your first release in seconds!

Get started
Subscribe to Changefeed updates
Copyright © 2019 Maximilian Stoiber e.U. · Terms · Privacy Policy · Impressum (DE)