Overview
Every deployment has a Release notes section on its detail panel — the human-readable story of the release, kept next to the record of what shipped. Because the deployment already knows its scope, Scrambl can draft the notes for you; your job becomes editing, not archaeology.
Who can do this
- Required access: an access level that includes Projects - Standard Access or Projects - Full Access.
- Default access levels that include it: Team Member, Accountant, and System Administrator.
- Owners and admins: always allowed. Workspace owners and admins are not limited by access levels.
- You also need access to the project the deployments belong to.
- Personal accounts: The Family Admin, Family Member, and Limited Member presets include this access. The space owner and admins can always do it.
Owners and admins review and change access levels in Settings → Administration → Members → Access levels.
Before you start
- Open the deployment from the project's Deployments tab.
- Make sure the scope is populated — add items by hand or run detection first. Notes are written from what ships, so an empty scope means an empty draft.
Generate a draft
- Scroll to the Release notes section at the bottom of the deployment detail panel.
- Click Generate. Scrambl reads the tasks and tickets in scope and drafts structured notes from them. Generating uses AI credits from your workspace allowance.
- If notes already exist, you will be asked to confirm before they are replaced.
Edit and polish
- The notes live in a rich text editor — rework headings, lists, and wording directly in place.
- Edits save automatically as you type; there is no separate publish step inside the panel.
- Write for the audience who will read them: lead with what changed for users, and keep internal ticket language out of the headline items.
Share the notes
- Teammates read the notes on the deployment itself, from the project's Deployments tab or from the Deployments section on any task or ticket in scope.
- Clients can see them too: deployments marked as visible in the client portal show their release notes there, formatted for reading.
Best practice: Generate after detection has run and the scope is final. A draft written from half the scope needs rewriting; a draft written from the finished scope usually just needs a trim.
Troubleshooting
| Issue | What to check |
|---|---|
| The Generate button is disabled. | Your workspace may be out of AI credits, or a generation is already running. |
| The draft is thin or generic. | The scope is the source material — link the real tasks and tickets, and give them clear names and descriptions. |
| Clients cannot see the notes. | The deployment must be marked as visible in the client portal. |
Next steps
- Automate scope detection so notes always start from the truth — see the CI integration article.
- Review the module basics in the deployments overview.