# Release notes templates

From https://devrelay.so/blog/release-notes-template. Eight templates, one per place release notes go. Delete the sections you don't need; keep anything that needs action at the top.

---

## 1. Product update (SaaS)

```
# [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]
```

---

## 2. Email and in-app message

```
**[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]
```

---

## 3. API and SDK

```
# [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]
```

---

## 4. Mobile app store

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

New
• [Feature, one line]

Improved
• [Improvement, one line]

Fixed
• [Symptom that's gone, one line]
```

---

## 5. GitHub release

```
## [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]
```

---

## 6. Internal release

```
# [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]
```

---

## 7. Hotfix

```
# 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]
```

---

## 8. Jira and Confluence

```
# [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.]
```
