# A release notes template for small software teams

*A copy-ready release notes template, the fields it needs, and a step-by-step way to fill it in by hand or from GitHub. We make Paragraph Changelog, one of the options compared here.*

By [Paragraph](https://paragraph.com/@blog), 2026-11-17

guides

---

**Contents**

*   Where can you find a release notes template for software?
    
*   What should a software release notes template include?
    
*   How do you write release notes step by step?
    
*   Which release notes option fits your team?
    
*   Can release notes be written from your GitHub work?
    
*   Start with your next release
    

Small teams often ship faster than they write about it. When updates stay buried in pull requests, customers may miss changes they could use \[[10](https://paragraph.com/@blog/see-whats-worth-announcing-from-your-github-work)\]. A shared template gives everyone on the team the same shape to fill in, so the important parts don't get skipped.

Where can you find a release notes template for software?
---------------------------------------------------------

You can copy the one below, or start from a published one. Good starting points are Keep a Changelog for a developer-facing changelog file \[[1](https://keepachangelog.com/en/1.1.0/)\], Asana's release note template for product updates \[[4](https://asana.com/templates/release-note)\], and a Confluence release notes template if your team documents in Confluence \[[5](https://k15tpublic.atlassian.net/wiki/spaces/PDFTL/pages/5636647/Release+Notes+Template)\].

If your code lives on GitHub, its automatically generated release notes give you a raw first pass \[[3](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)\]. Whichever you choose, pick one shape and use it for every release.

What should a software release notes template include?
------------------------------------------------------

At minimum, include the product name, version number, release date, new features, bug fixes, and any known issues \[[4](https://asana.com/templates/release-note)\]. If you do nothing else, list deprecations, removals, and any breaking changes \[[1](https://keepachangelog.com/en/1.1.0/)\].

A few additions make it more useful:

*   **A highlights section.** Open with a short summary of the most impactful additions and changes \[[5](https://k15tpublic.atlassian.net/wiki/spaces/PDFTL/pages/5636647/Release+Notes+Template)\].
    
*   **An Unreleased section.** Keep one at the top of your working file to track upcoming changes \[[1](https://keepachangelog.com/en/1.1.0/)\].
    
*   **Setup steps.** Give step-by-step notes for any setup or installation requirements \[[4](https://asana.com/templates/release-note)\].
    
*   **Honest known issues.** Be upfront about unresolved problems \[[4](https://asana.com/templates/release-note)\].
    

Here's a template you can copy:

    ## Unreleased
    - (collect changes here as they merge)
    
    ## [Product name] X.Y.Z - YYYY-MM-DD
    
    ### Highlights
    A short summary of what matters most.
    
    ### Breaking changes, deprecations, and removals
    - What changed, who it affects, what to do.
    
    ### New features
    - Feature: what it lets you do.
    
    ### Bug fixes
    - What was broken and is now fixed.
    
    ### Setup or upgrade steps
    - What to do before or after upgrading.
    
    ### Known issues
    - Issue and workaround, if any.
    

### How should you number versions?

Use Semantic Versioning, which numbers releases as MAJOR.MINOR.PATCH \[[2](https://semver.org/)\]. Once a version is released, its contents must not be modified, and any change goes out as a new version \[[2](https://semver.org/)\]. Your notes can follow the same rule: correct a mistake in the next release, and say so.

How do you write release notes step by step?
--------------------------------------------

Gather what merged, cut it down to what users notice, and rewrite it in plain words. The manual version looks like this:

*   **Collect merged changes.** GitHub's generated notes list merged pull requests, contributors, and a link to the full changelog \[[3](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)\]. You can use labels to group pull requests into categories and exclude certain labels and users \[[3](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)\].
    
*   **Cut the noise.** Commit log diffs make poor changelogs because they're full of noise \[[1](https://keepachangelog.com/en/1.1.0/)\]. Check that the notes include all, and only, the information you want \[[3](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)\].
    
*   **Lead with what breaks.** Put breaking changes, deprecations, and removals near the top \[[1](https://keepachangelog.com/en/1.1.0/)\].
    
*   **Rewrite for users.** Describe what each change lets someone do, and leave out how the code changed.
    
*   **Publish where customers look.** A changelog page, an email, or a social post. Pick the places your users already read.
    

This works well for a few releases. It gets tedious when you ship every week across several products.

Which release notes option fits your team?
------------------------------------------

It depends on who reads your notes and how much rewriting you want to do. Here's how the common options compare.

Option

Best for

What you get

Work left for you

Keep a Changelog

Developer-facing projects

A curated, chronological list of notable changes per version \[[1](https://keepachangelog.com/en/1.1.0/)\]

Writing every entry

Asana template

Product update notes

Fields for features, fixes, and known issues \[[4](https://asana.com/templates/release-note)\]

Writing and publishing

GitHub generated notes

A fast first draft

Merged PRs, contributors, and a full changelog link \[[3](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)\]

Reviewing and rewriting \[[3](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)\]

Paragraph Changelog

Announcing releases to customers

An article, X and LinkedIn posts, and a short video from your repos \[[7](https://docs.paragraph.com/playbooks/changelog)\]

Reviewing and approving \[[6](https://paragraph.com/changelog)\]

If your readers are developers checking a changelog file in the repo, Keep a Changelog is enough. If you only need a GitHub release page, generated notes with good labels will do. If you also want each release to reach customers by email and social, a tool that drafts those announcements from your repos saves the rewriting.

Can release notes be written from your GitHub work?
---------------------------------------------------

Yes. We built [Paragraph Changelog](https://paragraph.com/changelog) for this. Paste any GitHub repository, and Paragraph turns what you merge into a changelog your customers can subscribe to, with posts for X and LinkedIn and a short launch video \[[6](https://paragraph.com/changelog)\].

*   **Less noise.** It reads the pull requests, issues, and releases around your commits, so "wip" and "fix typo" never reach customers \[[6](https://paragraph.com/changelog)\]. Dependency bumps, lint passes, reverts, and merge commits stay out unless they changed something real \[[6](https://paragraph.com/changelog)\].
    
*   **Sized to the release.** Major features can get more social posts and a newsletter, while smaller ones get a lighter treatment \[[10](https://paragraph.com/@blog/see-whats-worth-announcing-from-your-github-work)\]. A smaller update goes to your site without an email \[[7](https://docs.paragraph.com/playbooks/changelog)\].
    
*   **Public repos just work.** They don't need a GitHub connection \[[7](https://docs.paragraph.com/playbooks/changelog)\].
    
*   **Fits your pipeline.** A CI job can [draft a post when a release ships](https://docs.paragraph.com/developers/playbooks) \[[11](https://docs.paragraph.com/developers/playbooks)\].
    

You stay in control. Every entry waits for your approval before it publishes, emails anyone, or posts to a social account \[[6](https://paragraph.com/changelog)\].

Your first two Changelog campaigns are free \[[6](https://paragraph.com/changelog)\]. On the Free plan, a Changelog runs only when you choose Run now \[[7](https://docs.paragraph.com/playbooks/changelog)\]. If you ship often, [plans](https://paragraph.com/pricing) are sized by how much you ship \[[8](https://paragraph.com/pricing)\].

Start with your next release
----------------------------

Copy the template above into your repo and fill it in for the next version you ship. If you'd rather start from your merged work, [paste a repository into Paragraph](https://app.paragraph.com/onboard?source=changelog) and review the draft it writes. The [Changelog docs](https://docs.paragraph.com/playbooks/changelog) explain what each run drafts. Questions go to [hello@paragraph.com](mailto:hello@paragraph.com).

Sources
-------

1.  [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
    
2.  [Semantic Versioning 2.0.0 | Semantic Versioning](https://semver.org/)
    
3.  [Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)
    
4.  [Release Notes Template for Software and Product Updates](https://asana.com/templates/release-note)
    
5.  [Release Notes Template (K15t PDF Template Library, Confluence)](https://k15tpublic.atlassian.net/wiki/spaces/PDFTL/pages/5636647/Release+Notes+Template)
    
6.  [Developer changelog, written from your commits | Paragraph](https://paragraph.com/changelog)
    
7.  [Changelog | Paragraph Docs](https://docs.paragraph.com/playbooks/changelog)
    
8.  [Pricing | Paragraph](https://paragraph.com/pricing)
    
9.  [See What's Worth Announcing From Your GitHub Work — Paragraph](https://paragraph.com/@blog/see-whats-worth-announcing-from-your-github-work)
    
10.  [Playbook runs | Paragraph Docs](https://docs.paragraph.com/developers/playbooks)

---

*Originally published on [Paragraph](https://paragraph.com/@blog/a-release-notes-template-for-small-software-teams)*
