Free templates
Release notes template for small SaaS teams
Copy one of the four templates below, fill in the brackets, and you have release notes your users will read. Each one is plain Markdown, so it works in a GitHub release, a CHANGELOG.md file, an email, or a hosted changelog page.
How to use these templates
Write for the person using your product, and leave the commit log out. Start with what they can do now that they couldn't before. Fixes they asked about come next, and anything they have to change on their side goes at the end. Keep each line to one change and link the docs when a change needs more than a sentence.
Template 1: a regular product update
## [Version or date]: [One line on the biggest change]
### New
- [Feature name]: [what users can do now, in one sentence]. [Link to docs]
### Improved
- [Area]: [what got faster, simpler or clearer]
### Fixed
- [The problem users saw], which now [works as expected]
Thanks to [customer or community member] for reporting [issue].
Template 2: a breaking change or API update
## [Version]: [Name of the change] (action needed by [date])
### What is changing
[Old behaviour] will stop working on [date]. [New behaviour] replaces it.
### What you need to do
1. [First step, with a code sample or link]
2. [Second step]
### If you do nothing
[What happens on the cutoff date]
Questions go to [support address or forum link].
Template 3: mobile app store release notes
What's new in [version]:
- [Feature in plain words, no internal names]
- [Fix users noticed, for example "Photos no longer fail to upload on slow connections"]
Enjoying [App name]? A review helps other people find us.
The store listing shows only the first few lines before a "more" link, so put the change users care about first.
Template 4: a monthly roundup
# [Month year] at [Product]
[Two or three sentences on the theme of the month.]
## Highlights
- [Biggest feature, with a screenshot or GIF]
- [Second feature]
## Everything else
- [Smaller improvements, one per line]
## Coming next
- [What you are working on, if you share a roadmap]
Where to publish them
A template only helps if users can find the result. ShipLog hosts your changelog page and adds an in-app widget with a "what's new" badge, which puts the notes in front of users while they are inside your product. The free plan holds 10 entries and Captain is $9 a month per project.
If your notes already live in GitHub, the GitHub releases to changelog tool turns them into a page in one step.
Not sure which one you are writing? Read Changelog vs release notes .
For step-by-step advice with before and after examples, read How to write release notes people read .
Keeping a CHANGELOG.md for developers? Read Keep a Changelog format, explained .