Write release notes from a release record
Get customer and team release notes drafted from the release's own records - finished cards, API changes and verified design steps - edit them, export them and share them by link.
In short
Release notes are written from records, never invented: the cards finished on connected boards since the last release, the API changes the record froze, and the design steps verified. You get customer notes in plain words and team notes with card keys, edit them, then export or share them.
Before you start
- Who: opening and reading the notes needs View. Saving and polishing need Edit. Sharing and revoking a link need Manage.
- Plan: every plan. "Polish with AI" needs your own AI key or a paid plan on this workspace.
- First: record a release (see /help/api-testing/release-records).
Steps
- Open the project's "Ship" › "Release" and open a record.
- Press "Release notes". A draft is written from the records.
- Switch "Notes for" between "Customers" and "Team", and edit the words.
- Press "Save notes".
- Press "Export Markdown" or "Export Word", or make a link to the customer notes and press "Copy link".
Result: the customer notes read "What is new", "Fixed", "API changes" (breaking ones marked) and "Checked and verified".
Good to know
- Customer notes carry no card keys and are the only notes you can share. Team notes add card keys and links, the verdict and what was hidden.
- Cards on connected boards you cannot open are left out and counted.
- "Start again from the records" throws your edits away and writes the draft again.
- "Polish with AI" rewords the notes; you compare and choose "Use this" or "Keep mine". It needs your own AI key or a paid plan.
- A link shows the saved customer notes and nothing else. It ends by itself; "Revoke" ends it now.
Nothing new is added If the AI's wording adds a number, a key or a link the records do not hold, it is refused whole and your notes stay as they were.
If something goes wrong
- "Save the customer notes first, so you share what you read."
- "The AI added something the records do not say, so its wording was not used."
- "Someone saved these release notes while you were editing. Reload to see their version."
- "Polishing needs your own AI key, or a paid plan on this workspace."
Related
- /help/api-testing/release-records
- /help/api-testing/api-changes
- /help/designer/prove-a-feature