Release Notes: Turn a Release Into News Users Read
Release notes are marketing as much as documentation. Lead with highlights users will feel, not internal changes.
What is the Release Notes Builder?
Enter a version and its highlights, one per line, and the tool drafts friendly release notes with a highlights list. This is a starting draft to edit in your product's voice before publishing.
How to use it
- Enter the version number.
- List the highlights, one per line.
- Click Build Release Notes.
Worked example
For version 2.0, the notes highlight a new dashboard, faster loading, and improved sharing.
What should release notes lead with?
The highlights: the new or improved things users will notice first, in plain language.
Frequently asked questions
How long should release notes be?
Short: three to five highlights, plus a line on fixes if needed.
Should I mention bug fixes?
Briefly, grouped together, so they do not bury the highlights.