Guides ยท Engineering
Release Notes Basics
Write clear release notes
This guide explains how to write concise release notes: highlight user-facing changes, impacts, required actions, known issues, and links to docs or rollbacks.
- release notes
- changelog
- product updates
- communication
- docs
Lead with highlights
List top changes in bullets with user-facing language.
State impacts and actions
Note who is affected, any required steps, and timing.
Add known issues
Call out limitations or workarounds; link to tickets if needed.
Link resources
Add docs, support contacts, and rollback instructions.