- Item
- Version
- Content
- Empty
- Check
- Unchecked
TemplatesWork & projects · Release notes
Release notes and changelog
When you gather product or service changes into release notes and split up the checks before announcing them
What's inside · Table 3 · Checklist 3
Preview · a new document starts like this
Release notes and changelog
- Next release
- Not set
- Assignee
- Not set
- Release cycle
- Not set
Write the version and date in the This release table, then fill in the list of changes.
This release
| Item | Content | CheckCheckbox |
|---|---|---|
| Version | Empty | Unchecked |
| Date | Empty | Unchecked |
| One-line summary | Empty | Unchecked |
- Item
- Date
- Content
- Empty
- Check
- Unchecked
- Item
- One-line summary
- Content
- Empty
- Check
- Unchecked
Changes
One line per change. Write it in words your users would understand.
Changes
| Change | Type | Impact | Needs announcement | Status | Notes |
|---|---|---|---|---|---|
| One line about what got faster | Improvement | All users | Unchecked | Not set | Not set |
| One line about a fixed problem | Fix | Some users | Unchecked | Not set | Not set |
| One line about a new feature | New feature | All users | Unchecked | Not set | Not set |
- Type
- Improvement
- Impact
- All users
- Needs announcement
- Unchecked
- Status
- Not set
- Notes
- Not set
- Type
- Fix
- Impact
- Some users
- Needs announcement
- Unchecked
- Status
- Not set
- Notes
- Not set
- Type
- New feature
- Impact
- All users
- Needs announcement
- Unchecked
- Status
- Not set
- Notes
- Not set
Publishing checklist
| Item | AssigneeAssignee | DoneCheckbox |
|---|---|---|
| Copy review | Empty | Unchecked |
| Screenshots | Empty | Unchecked |
| Announcement channels | Empty | Unchecked |
| Update the docs | Empty | Unchecked |
- Item
- Copy review
- Assignee
- Empty
- Done
- Unchecked
- Item
- Screenshots
- Assignee
- Empty
- Done
- Unchecked
- Item
- Announcement channels
- Assignee
- Empty
- Done
- Unchecked
- Item
- Update the docs
- Assignee
- Empty
- Done
- Unchecked
Logging rules
•
Say what changed in one sentence, from the user's point of view.
•
For fixes, describe when the problem used to happen.
•
For removed features, say what to use instead.
☐
Marked the type of each change.
☐
Checked the changes that need an announcement.
☐
Finished the checks before publishing.