How to write impactful release notes

Oshini Nugapitiya
3 min readApr 13, 2023

A release note is a document published alongside new or updated software. It includes a summary of what features have been added, what issues have been fixed, and the improvements of the product. In simple terms, release notes inform the user about the latest state of the product in relation to the previous version.

The content of release notes

Release notes are highly important for new or updated software because they help communicate with the customer regarding new features, bug fixes, product improvements, UX changes, and UI redesigns. Release notes are an opportunity to keep your customers excited about your product and it improves user engagement. Release notes can also be considered as educational material for the user as it includes what has changed since the previous release and what are the latest features in the current release. Let’s explore some of the best practices to write impactful release notes for software.

1. Use simple language

Use plain, simple language and avoid technical jargon. You don’t have to be too technical when writing release notes. For example, if you have bug fixes in the new version, don’t go deep into what was fixed and how it was done. Simply let them know that the bug has been addressed and ensure that they won’t encounter it again. But don’t forget to be clear and exact about your update. Without saying “We fixed a bug”, expand it like “We fixed a bug that was causing X feature to lag when Y happened”.

2. Keep them short

Release notes should be informative but at the same time, they should be a brief overview with one or two sentences. Be relevant and straightforward. Using a clear heading and bullet points for release notes will make them easy to read and understand.

H2O.ai Feature Store release notes

3. Be customer-centric

Always keep in mind that you write release notes for your customers. They are the end-users of the release notes you write and you talk directly to them. So keep it engaging and make it super easy for them to understand by using less comprehensive language. For example, instead of saying “The app now supports downloading a list of users as a text file”, you can say “You can now download a list of users as a text file” which is more engaging with the customer and talks to them. This way, they will realize that you are putting them first and adding new features to help them.

4. Use your brand’s voice

Release notes can be used to promote your brand but overdoing it may be unnecessary and can break the customer’s trust in your brand because release notes should not turn into a sales pitch. The most important thing is maintaining your brand’s tone. If your brand usually uses a fun and friendly tone, so should release notes. But if your brand’s tone is more formal, use the language accordingly, and don’t crack jokes in release notes.

5. Include relevant links

Even though release notes provide a high-level understanding of the new changes, customers might want more information. By including relevant links to detailed documentation such as user guides, workflows, or video tutorials you can communicate a lot about the product and features to your customer.

6. Use visual aids

No matter how well structured, long lines of text can create fatigue and cause information overload. Adding screenshots, images or videos can be more appealing and will allow you to communicate more effectively. This is specifically helpful when you have significant UI/UX improvement. It’s easy and more convenient to show them in a screen capture or a small video clip than explain the changes in the form of text.

Wrapping up

Release notes are important and they are a key part of your product strategy that helps your customers to stay up-to-date with the latest improvements in the product. Treat it with care and follow the best practices when writing release notes. It is an opportunity to show your customers that you listen to their feedback and improve their engagement.

--

--