Guides › Documents & Data
Write release notes your users actually read
Friendly release notes and a short how-to for users, turned from your commit messages and ticket titles, plus a separate technical changelog.
When to use it
Every release
Step by step
Collect what changed
Copy the commit messages, merged pull request titles or ticket list for this release. Remove internal names and anything customers shouldn't see.
Ask for two versions
Paste this into your AI assistant.
Prompt to copyHere are the changes in release [version] of [product], which is used by [type of users]: [paste commits / PR titles / tickets]. Write two things. 1) User release notes: a short intro, then sections New, Improved and Fixed, each item one plain sentence about what the user can now do, with no internal jargon. Leave out purely internal changes. Add a 3-step 'How to try it' for the biggest new feature. 2) A technical changelog for developers in Keep a Changelog format, including breaking changes and migration steps. Flag any item where the user impact is unclear so I can check.Check and edit
Make sure nothing promises more than the feature does, and remove anything not yet released.
Publish
Post the user notes in your app, help centre or GitHub release, and the changelog in your repository.
What you get
New: Export your monthly orders to a spreadsheet in one click. Improved: Search now finds customers by phone number. Fixed: Discounts now show correctly on VAT invoices. How to try it: 1) Open Orders...
Tips
- Clear commit messages make this much better; ask the assistant to suggest a commit message style for your team.