Release Note Template
What changed, written for the business owner. Answers three questions: what is different, do I need to do anything, and did anything I rely on change. A commit log answers none of them.
Syntax
implementor-onboarding
What changed — [tenant] — [date]
New
- [outcome, in their language]
Improved
- [outcome, and what it now lets them do]
Fixed
- [what was wrong] [and the blast radius — who was affected while it was live]
You should know
- [anything they must do, or an explicit "nothing you need to do"]
Next
- [what is coming, and when they will see it]Parameters
| Parameter | Type | Description |
|---|---|---|
| blast radius | impact statement | Who was affected while the bug was live. Uncomfortable to write; the owner may have quotes to chase. |
| You should know | action or reassurance | Explicitly say when nothing is required. Silence reads as an unstated expectation. |
Example
implementor-onboarding
Fixed
- The contact form was dropping the phone number on mobile. It no
longer does. Requests submitted before today may be missing that
field, so it's worth checking any you haven't followed up.
You should know
- Nothing you need to do.
- The old /gutters URL still works and forwards to the new page, so
anything you've printed is fine.