# Release notes templates

Six templates from userjot.com/blog/release-notes-template. Each is plain Markdown, so it pastes into GitHub, Notion, Confluence, Google Docs or Word. Replace every bracketed line. Delete any heading that has nothing under it.

## 1. Feature release

```
# [What you can do now, in the words a user would use]

[Date]

[What you can do now, in one or two sentences.] Previously, [what it was like before].

[One concrete case where this matters.]

Available on [plans or platforms]. [How to turn it on or where to find it.]

Built from this request: [link to the feedback request, if one exists]
[Link to the docs]
```

## 2. Weekly or monthly round-up

```
# [Product] updates, [date or week]

[One sentence on the biggest change this period, if there is one.]

## New
- [What you can do now, one line each]

## Improved
- [Area]: [what is better, one line each]

## Fixed
- [Area]: Fixed [the symptom, as the user saw it]
```

## 3. Bug fix or hotfix

```
# [Version], [date]

Fixed: [what was broken, as the user saw it, with the screen or feature named].
[Who was affected, if not everyone.]
[What to do, or "No action is needed."]
```

## 4. Breaking change, API change or deprecation

```
# [Version or API date], [what changed]

**What's new.** [What the change does.] Previously, [what it replaced].

**Breaking:** [yes or no]. [Who is affected: which endpoint, field, SDK or setting.]

**What to do.**
1. [Upgrade step]
2. [Upgrade step]

[Rollback window or how to pin the old behaviour, if there is one.]
[Deprecation date, if the old behaviour is going away.]
[Link to the migration guide or API reference.]
```

## 5. Rename, move or settings change

```
# [Old name] is now [new name]

[Date]

[Old location] is now [new location]. [Old links or paths] still work. [What has not changed.]
```

## 6. App Store and Google Play "What's New"

Under 500 characters, so one text passes both stores. No request to rate or review the app.

```
<en-US>
New: [the one change that matters, with the screen or feature named].
[Second change, if there is one.]
Bug fixes and stability improvements.
</en-US>
```
