Changelog template
Use a consistent structure for release notes so merchants and partners can understand what changed quickly.
Summary
Use a consistent structure for release notes so merchants and partners can understand what changed quickly.
Where to find it
Documentation → Docs Operations → Changelog template
Before you start
- Know which product changes need to be announced.
Steps
- Start with a short release title and summary.
- Split the user-facing impact into merchants and partners.
- Add any action needed after the release.
- Link to the exact docs pages that changed.
How to use this template
- Release notes should explain workflow impact, not internal implementation.
- If a change affects only one role, say that clearly.
Example
A payout improvement release note would explain what changed for merchants reviewing requests, what changed for partners submitting requests, and whether anyone needs to update settings.
Tips and limits
- Avoid technical release notes in this docs project.
- If there is no user-facing impact, you may not need a public changelog entry.
Release title
Add a one-line summary that explains what changed and who should care.
What changed for merchants
List merchant-facing workflow or settings changes in plain language.
What changed for partners
List partner-facing dashboard or storefront changes in plain language.
Action needed
Explain whether merchants or partners need to update any settings, review any alerts, or communicate any changes.