Release Notes Template: 8 Copy-Paste Formats with Examples

A software release notes template with a sample, plus eight to copy or download: SaaS update, email, API, app store, GitHub, internal, hotfix and Jira.

By RahulUpdated 10 min read
A release notes template with a title, summary, and New, Improved and Fixed sections

The short answer

A release notes template needs five parts: a title that names the change, a one-sentence summary, anything that needs action first, then New, Improved and Fixed with one line per change, and a link to more detail. Pick the template by where the notes will be read: a product update, an email, an SDK release, an app store, a GitHub release, an internal note, a hotfix or a Confluence page built on what Jira generates. All eight are downloadable Markdown files.

Key takeaways

  • Choose the template by where the notes are read and who reads them.
  • Name the change in the title; keep the version next to it, not in it.
  • Anything that needs action goes first, with the one step to take.
  • Describe fixes by the symptom users saw, never by the code that changed.

Most release notes templates you'll find online are a list of headings: New features, Improvements, Bug fixes. The headings are fine. What they don't tell you is which headings your release actually needs, what a good line under each one looks like, and how the same release should read in an app store, a GitHub release and an email to customers.

This post gives you a full software release notes template with a filled-in sample, then eight release notes templates you can copy or download, one for each place release notes usually go, with an example for each. Then it covers what every set of release notes needs, how to word the lines, and a checklist to run before you publish.

Which release notes template to use

Pick the template by where the notes will be read and who reads them. The format follows the reader.

TemplateUse it forReaderLength
Software release notesThe master copy for versioned, installed or self-hosted softwareUsers and admins deciding when to upgradeAs long as the fields need
Product updateA SaaS release on your blog, changelog page or help centerCustomers, often non-developers150–400 words
Email and in-appOne change worth its own email or in-app messageEveryone affected50–120 words
API and SDKA library, SDK or API versionDevelopers upgradingAs long as the changes need
Mobile app storeApp Store "What's New" and Google Play release notesApp users scanning an updateUnder 500 characters
GitHub releaseThe body of a tagged GitHub releaseWatchers, contributors, integratorsSummary plus the full list
Internal releaseIT, ops, support and sales teamsColleagues who field questionsOne screen
HotfixA fix shipped outside the normal cycleUsers who hit the problemUnder 100 words
Jira and ConfluenceA Confluence page built on the list Jira generates for a versionCustomers and colleagues who don't open JiraA summary plus the generated list

If you only publish in one place, start with the product update template. It's the one the others are cut down from.

Download the templates

Every template below is a plain text file you can save and reuse. Markdown works as it is in GitHub, GitLab, Notion, Slack and most docs tools.

TemplateFile
All eight in one filerelease-notes-templates.md
Software release notes (every field)software-release-notes.md
1. Product update (SaaS)product-update.md
2. Email and in-app messageemail.md
3. API and SDKapi-sdk.md
4. Mobile app storeapp-store.txt
5. GitHub releasegithub-release.md
6. Internal releaseinternal.md
7. Hotfixhotfix.md
8. Jira and Confluencejira-confluence.md

Google Docs: copy a template, then right-click in the document and choose "Paste from Markdown". Google Docs converts the headings, bold text and links; as of October 2026, Google's help page also describes importing a .md file with File → Open → Upload. Word: paste the text and apply the Heading 1 and Heading 2 styles to the lines that start with #, then delete the # signs. Confluence: see template 8, which is built for the page Jira creates.

Anatomy of release notes: a title naming the benefit, a one-sentence summary, a section for anything that needs action, new and improved and fixed sections, and a link to more detail
The five parts every template below is built from.

What every set of release notes needs

Whatever the template, the same five parts do the work:

  1. A title that names the change, not the version. "Schedule replies to send later" tells a reader whether to keep going; "Release 4.12" doesn't. Keep the version and date next to the title, not in it.
  2. A one- or two-sentence summary of what this release is about and who it affects. Many readers stop here, so it has to stand on its own.
  3. Anything that needs action, first. Breaking changes, required migrations, removed features, new permissions. If nothing needs action, leave the section out.
  4. New, Improved and Fixed, in that order, one line per change. Each line describes what the user can now do or what stopped going wrong.
  5. A link to more detail: the docs page, the migration guide, or the full changelog.

Everything else is optional: screenshots, a known issues list, credits, an upgrade command. Add them when they help the reader act.

Software release notes template (every field)

A software release notes template is the full set of fields a release can need: a title that names the change, a line with the product, version, date and platforms, a short summary, anything that needs action, then New, Improved, Fixed and Known issues, and links to more help. Use it as the master copy for installed software, self-hosted products and anything shipped in numbered versions, and delete the fields a release doesn't need. The eight templates further down are this one cut to fit a place.

# [The main change, as a benefit]
[Product] [version] · Released [YYYY-MM-DD] · [Windows, macOS, Linux, Web, iOS, Android]
Upgrade from: [oldest version that can upgrade directly, if it matters]

## Summary
[One or two sentences: what this release does for users and who it affects.]

## Action needed
- [Breaking change, removed feature or required migration]: [who it
  affects] and [the one step to take]. [Link to the migration guide]

## New
- **[Feature name]**: [what users can now do, in one sentence]. [Docs link]

## Improved
- [What works better], in terms users notice ([old] → [new] if measured).

## Fixed
- [The symptom users saw] no longer happens.

## Known issues
- [What still goes wrong], [who it affects], [the workaround], [when a
  fix is expected, if you know].

## More
[Docs] · [Full changelog] · [Support contact]

Filled in for Acme Inbox's desktop app, a made-up help desk:

# Schedule replies to send later
Acme Inbox 4.12 · Released 2026-10-02 · Windows, macOS
Upgrade from: 4.0 or later

## Summary
You can now choose when a reply goes out, so customers in other time
zones hear back during their working day.

## Action needed
- Windows 10 version 1809 is no longer supported. Update Windows before
  installing 4.12; 4.11 keeps working until March 2027.

## New
- **Send later**: pick "Send later" next to Send and choose a time.
  Scheduled replies wait in the new Scheduled view. How to schedule →

## Improved
- The app opens faster on large mailboxes (about 6 s → 2 s at 50,000 tickets).

## Fixed
- Attachments over 10 MB no longer fail silently; you now see the limit.

## Known issues
- Scheduled replies don't sync to the mobile app yet. They still send
  on time. A fix is planned for 4.13.

## More
Help center · Full changelog · support@acme.example

What each field is for, and when to drop it:

FieldKeep it whenDrop it when
VersionUsers install, pin or upgrade versionsA hosted product updates for everyone at once
PlatformsBuilds differ by operating system or deviceThere is one web app
Upgrade fromOld versions can't upgrade directlyEvery version upgrades cleanly
Action neededSomething breaks, is removed or needs a stepNothing changes for existing users
Known issuesA problem is known and users will hit itThere are none worth a reader's time

A known issue you list is a support ticket you don't get. Name the symptom and the workaround, the same way you word a fix.

1. Product update template (SaaS)

Use this product release notes template for a release of a hosted product, published on your blog, changelog page or help center. Your readers are customers, many of them not developers, so write in terms of what they do in the product.

# [What changed, as a benefit]
[Date] · [Product area, optional]

[One or two sentences: what you can do now that you couldn't before,
and who it's for.]

## What's new
- **[Feature name]**: [what you can do with it, in one sentence].
  [Link to the help article]

## Improved
- [Thing that works better]: [how it's better, in terms users notice].

## Fixed
- [The symptom users saw] no longer happens.

## Action needed (only if something changes for existing users)
- [What changes], [who it affects], [the one step to take] by [date].

Questions? [Contact or help link]

Filled in for Acme, a made-up help desk:

# Schedule replies to send later
October 2, 2026 · Inbox

You can now write a reply and choose when it goes out, so customers
in other time zones hear back during their working day.

## What's new
- **Send later**: pick "Send later" next to Send and choose a time.
  Scheduled replies appear in the new Scheduled view until they go out.
  How to schedule a reply →

## Improved
- Search finds tickets by customer email domain, not just full address.

## Fixed
- Attachments over 10 MB no longer fail silently. You now see an error
  with the size limit.

Questions? Reply to this email or visit the help center.

Notice what the example leaves out: the version number, the pull request, the name of the queue that sends scheduled replies. Customers can't use any of that.

2. Release notes email template (and in-app message)

When one change matters more than everything else in the release, give it its own short note. This is the release notes template for a product email, an in-app announcement or a "What's new" panel. It works as the whole email, or as the opening of a longer one with the full notes underneath. For whole emails (a monthly update, a price change, a breaking change), see the product update email templates.

**[Feature name] is here**

[The problem it solves, in one sentence, in the user's words.]

[What to do: where to find it and the first step.]

[Button or link: Try it / Learn how]
**Send later is here**

Replying at 11pm shouldn't mean your customer gets an email at 11pm.

Choose "Send later" next to Send, pick a time, and Acme sends it then.

Learn how →

Keep it to one change. A second feature in the same message halves the attention each gets; put it in the full release notes instead.

3. API and SDK template

Developers reading SDK or API release notes are deciding whether and how to upgrade. They need the version, what breaks, and exact steps, before anything else.

# [Package] [version] ([YYYY-MM-DD])

[One sentence: the headline change.]

## Breaking changes
- `[old]` is removed. Use `[new]` instead. [Migration guide]

## Deprecated
- `[name]` will be removed in [version]. Use `[replacement]`.

## Added
- `[function or endpoint]`: [what it does]. [Docs]

## Changed
- [Behaviour that changed], [old] → [new].

## Fixed
- [Error message or symptom] when [condition]. ([#issue])

## Upgrading
[install or upgrade command]
[Any code change needed, as a before/after snippet]
# acme-sdk 3.0.0 (2026-10-02)

Replies can be scheduled from the API.

## Breaking changes
- `sendReply(ticket, body)` now takes an options object:
  `sendReply(ticket, { body })`. Migration guide →

## Added
- `sendReply(ticket, { body, sendAt })` schedules a reply.
  `sendAt` is an ISO 8601 time, up to 30 days ahead. Docs →

## Fixed
- `uploadAttachment` rejected files over 10 MB with a generic
  "request failed". It now returns `attachment_too_large`. (#812)

## Upgrading
npm install acme-sdk@3

For the complete history across versions, keep a CHANGELOG.md alongside these notes. Our guide on how to write a changelog covers that format, and release notes vs. changelog explains when you need both.

4. Mobile app store template

App store release notes are read in a list of updates, on a phone, in a few seconds. The stores also set hard limits. As of October 2026, Apple's App Store Connect reference limits "What's New in This Version" to 4,000 characters, and Google Play's help allows up to 500 Unicode characters of release notes per language and says not to use them for promotion or to ask users to take actions. Write to the shorter limit and both stores are covered.

[Headline change, as what the user can now do.]

New
• [Feature, one line]

Improved
• [Improvement, one line]

Fixed
• [Symptom that's gone, one line]
Schedule replies to send later: tap the clock next to Send.

New
• Scheduled view shows replies waiting to go out

Improved
• Faster inbox loading on slow connections

Fixed
• Large attachments now show an error instead of failing silently

That example is about 250 characters. Skip "Bug fixes and performance improvements" when you can: it tells people nothing, and a real line about a fix they hit is the reason they update. For each store's rules, five more app templates (bug fix, maintenance, something changed, multi-language, promotional text) and the fastlane files, see our guide to app release notes.

5. GitHub release template

A GitHub release has a tag, a title and a body. GitHub can generate the body as a list of merged pull requests, grouped by label if you add a .github/release.yml. That list is a good appendix but a poor opening, because it's written for reviewers. Put a human summary on top:

## [Headline change]

[Two or three sentences: what this release is about, with a short example.]

### Action needed
- [Breaking change and the step to take]

### Highlights
- [Most important change, with a docs link]
- [Second most important change]

### All changes
[Paste GitHub's generated list here]

**Full changelog**: [compare link between the two tags]
## Schedule replies from the API

You can now pass `sendAt` to `sendReply` to schedule a reply up to
30 days ahead.

    await acme.sendReply(ticket, { body, sendAt: "2026-10-03T09:00:00Z" })

### Action needed
- `sendReply` takes an options object. See the migration guide.

### Highlights
- Scheduled replies (docs)
- Clear `attachment_too_large` error for files over 10 MB

### All changes
- Add sendAt to sendReply by @dana in #809
- Return attachment_too_large for oversized uploads by @lee in #812
- Bump eslint from 9.1 to 9.2 by @dependabot in #815

If your commits follow Conventional Commits, the generated list sorts itself. Our guide to automating your changelog from GitHub covers the tools that do it.

6. Internal release template

Support, sales and operations need to know about a release before customers ask about it. Internal release notes answer the questions they'll get, and the questions they'll have themselves.

# [Release name] · ships [date and time, time zone]

**What changes:** [one or two sentences]
**Who is affected:** [all customers / plan / region / feature flag]
**What customers will see:** [the visible change, with a screenshot]
**What customers need to do:** [nothing / the step]
**Known issues:** [list, or "none"]
**Rollback plan:** [how and who decides]
**Questions:** [owner and channel]
# Send later · ships Oct 2, 10:00 UTC

**What changes:** Agents can schedule replies.
**Who is affected:** All workspaces on Team and Business plans.
**What customers will see:** A "Send later" option next to Send, and a
Scheduled view in the sidebar.
**What customers need to do:** Nothing.
**Known issues:** Scheduled replies don't appear in the mobile app
until its next update.
**Rollback plan:** Feature flag `send_later`, owned by the Inbox team.
**Questions:** #inbox-team

7. Hotfix release notes template

A hotfix ships outside the normal release cycle, usually because something broke. People read hotfix notes to find out whether the problem they hit is the one you fixed and whether they have to do anything. Lead with the symptom, say who was affected and for how long, and keep it under 100 words. Don't bury the fix under new features; a hotfix note has no "What's new" section.

# Fixed: [the symptom, in the user's words]
[Date and time, time zone]

**What happened:** [What users saw, from when to when.]
**Who was affected:** [Everyone / plan / region / only users who did X.]
**What we fixed:** [The fix, in one sentence. No code names.]
**What you need to do:** [Nothing / the one step, such as refreshing or
re-running something.]
**Still open:** [Anything not yet resolved, or "nothing"]

Questions? [Contact or status page link]
# Fixed: scheduled replies sent twice
October 4, 2026, 14:20 UTC

**What happened:** Between 09:10 and 13:45 UTC, some replies scheduled
with Send later went out twice, a few seconds apart.
**Who was affected:** Workspaces that scheduled replies during that window.
About 2% of scheduled replies were duplicated.
**What we fixed:** A reply is now marked as sent before it leaves the
queue, so a retry can't send it again.
**What you need to do:** Nothing. We've emailed the affected workspaces
with the list of duplicated replies.
**Still open:** Nothing.

Questions? Reply to this email or check status.acme.com.

If the problem was a security issue, this template still works, but say what data was or wasn't exposed and what users should do about it, and have someone outside the team read it before it goes out.

8. Jira and Confluence release notes template

Teams that plan in Jira usually publish release notes on a Confluence page, and Jira can generate the first draft. As of October 2026, Atlassian's documentation says you open the version from the Releases tab, choose Release notes, and Jira generates release notes "for all the work items within a version, categorized by work type". You can copy them to the clipboard as Markdown or HTML, save them to the version, or create them in Confluence as a draft page. The notes are rebuilt from the version's current state each time you view them, and you can add a rich text field called "Release notes" to each work item so the generated list carries a written line instead of a ticket title.

That generated list is the appendix, not the release notes. Ticket titles are written for the team, grouped by work type (Story, Bug, Task) rather than by what users notice, and they include everything in the version, including internal work. Put a human summary above it:

# [Product] release · [date]

**Summary:** [One or two sentences: what this release is about and who
it affects, written for people who don't open Jira.]

**Action needed:** [What changes for existing users and the step to take,
or "nothing".]

## Highlights
- [The most important change, as what users can now do] · [docs link]
- [The second most important change]

## Fixed
- [Symptom users reported] no longer happens. ([Jira key, optional])

## Known issues
- [What still doesn't work and the workaround, or remove this section]

## All work items in this release
[Paste the release notes Jira generates for the version here, or put
them in an expand so the page stays short.]
# Acme Inbox release · October 2, 2026

**Summary:** Agents can schedule replies to send later, and search now
matches customer email domains. No changes to existing workflows.

**Action needed:** Nothing.

## Highlights
- Send later: pick a time next to Send, and the reply waits in the new
  Scheduled view until then · How to schedule a reply
- Search finds tickets by customer email domain, not just full address

## Fixed
- Attachments over 10 MB no longer fail silently; you see an error with
  the size limit. (INBOX-812)

## Known issues
- Scheduled replies don't appear in the mobile app until its next update.

## All work items in this release
> Story · INBOX-801 Schedule a reply to send later
> Story · INBOX-805 Scheduled view in the sidebar
> Task · INBOX-809 Add sendAt to the reply API
> Bug · INBOX-812 Large attachments fail without an error

Jira keys are fine on an internal Confluence page. On a customer-facing page, drop them, along with the generated list, and keep the summary, highlights and fixes.

How to word release note lines

The template gives the structure. The lines are where release notes are won or lost. Four rules cover most of it:

  • Start with what the user can do or see. "You can now schedule replies" beats "Implemented reply scheduling".
  • Describe fixes by the symptom. "Attachments over 10 MB no longer fail silently" tells people whether this is the fix they were waiting for. "Fixed upload bug" doesn't.
  • Use numbers only when users feel them. "Inbox loads in under a second on slow connections" is useful. An internal query count isn't.
  • Name things the way the product does. If the button says "Send later", the note says "Send later", not "deferred dispatch".
Weak and strong release note lines compared for a new feature, an improvement, a fix and a change that needs action
The same changes, written for the team that built them and for the people who use them.

Checklist before you publish

  • The title names the change, not just the version.
  • The summary works on its own if nobody reads further.
  • Anything that needs action is at the top, with the step to take.
  • Every line describes an effect a user can notice.
  • Internal work (refactors, dependency bumps, CI) is left out.
  • Every feature line links to the docs or help article.
  • Everything in the notes has actually shipped. Merged code that isn't released yet stays out.
  • The app store version fits in 500 characters.
  • A hotfix note leads with the symptom and says who was affected.
  • Support has the internal version before customers see the public one.

How DevRelay does it

If you'd rather not fill in templates by hand, DevRelay drafts release notes from what you actually ship. It watches your GitHub repositories, waits for the release (a merge alone isn't treated as shipped), and reads each change's pull request and diff. For a release, it drafts the announcement and a changelog entry grouped as New, Improved, Fixed and Changed, written for your product's users. It drafts X and LinkedIn posts from the same facts, and each week or month it can round up what shipped into a product update newsletter you paste into your email tool.

Every claim in a draft is checked against the code and the release before you see it, and nothing goes out until you approve it.

DevRelay inbox showing a draft with each claim checked against the evidence from the release
A draft in the inbox, with each claim traced to the release.

To try the idea on your own commits first, paste them into the free release notes generator. For a CHANGELOG.md, the Keep a Changelog generator builds the file's structure.

Frequently asked questions

What is a good format for release notes?

A title that names the main change, a one- or two-sentence summary, a section for anything that needs action, then New, Improved and Fixed with one line per change, and a link to the docs or full changelog. Leave out sections that would be empty.

What should be included in release notes?

Changes users can notice: new features, improvements, fixes described by the symptom they remove, and anything that requires action, such as breaking changes or migrations. Internal refactors, dependency bumps and CI changes don't belong in release notes.

What should a software release notes template include?

A title that names the main change, then the product, version, release date and platforms, a one- or two-sentence summary, anything that needs action, New, Improved and Fixed sections, known issues with their workarounds, and links to the docs, the full changelog and support. Drop the fields a release doesn't need.

How long should release notes be?

As short as the changes allow. A product update usually runs 150 to 400 words, a single-feature email 50 to 120 words, and app store notes should fit in 500 characters, Google Play's limit per language. SDK release notes can be longer when breaking changes need upgrade steps.

Should release notes include version numbers?

For libraries, SDKs and APIs, yes: developers need the version to decide whether and how to upgrade. For a hosted SaaS product, a date and a title that names the change are more useful to customers than an internal version number.

What is the difference between release notes and a changelog?

A changelog is a cumulative record of every notable change in every version. Release notes explain one release to its users: what's new, why it matters and what to do. Many teams write the changelog first and the release notes from it.

How do you write release notes?

List what shipped, drop anything users can't notice, then write one line per change starting with what the user can now do or what stopped going wrong. Put anything that needs action first, add a title that names the biggest change and a one-sentence summary, link each feature to its docs, and have someone outside the team read it before it goes out.

Is there a release notes template for Word or Google Docs?

Yes. Each template on this page is a Markdown file you can download. In Google Docs, right-click and choose Paste from Markdown and the headings and bold text convert. In Word, paste the text and apply the Heading styles to the lines that start with #.

How do I create release notes in Jira?

Open the version from the Releases tab and choose Release notes. Jira generates a list of the version's work items grouped by work type, which you can copy as Markdown or HTML, save to the version, or create as a Confluence draft page. Treat that list as the appendix and write a summary, highlights and fixes above it; the Jira and Confluence template on this page shows the layout.

Your next release deserves more than a merge commit.

Connect GitHub and your website. The next time you ship, the post, the changelog entry and the docs update will be waiting for your yes.

No credit card · Nothing posts without your approval