Release notes are our opportunity to generate excitement and sell the benefits of our new features and improvements. The article serves as a high-level overview and links off to more in-depth how-to help articles to talk about the specifics.

To write great release notes, you need to have the right preparation. Ensure you can check off everything on this list.

Use straightforward titles that include the version number. If you don’t use version numbers, or if you’re making a content release, you can use the month and year instead.

One sentence that highlights the one or two key features you’re wanting to talk about.

Welcome the readers to the release notes and add any extra information on the focus of the release.

Your article body should include at least two sections: What's new and How to access this update. You can also include Additional information if you feel you need to.

These headings will use the Heading 1 (H1) option, with Heading 2 (H2) for sub-sections. Headings 3 and 4 can be used if you need to drill into each section further.

Add this section to talk about the new features and improvements you’re releasing. Add each feature as a sub-heading and give a brief overview before linking off to any specific how-to help content.

🔎 Example

This section needs to be added to explain to the reader how they get the update. If required, include any information on where to download or request it.