Skip to content

Guides

What shipped, in words customers understand

Use Driver to translate a verified set of release changes into customer-facing notes. Gather the release owner’s change list, relevant Jira issues, and availability decisions before drafting.

  1. Select the before and after source. Supply the release diff or change list and the codebase branches that the release owner maps to those versions. A version label alone does not identify the source to compare.
  2. Ask Driver: “Use this release change list and the selected source to draft customer release notes. Group new capabilities, behavior changes, and fixes. For each item, state who benefits, what changed, any required action, and the supporting code or Jira issue. Flag uncertain availability for review.”
  3. With Advanced history prepared for the selected branch, ask Driver to inspect the prepared changelog for supporting changes. Check any candidate addition against the release owner’s change list before including it.
  4. Confirm deployment, plan restrictions, and feature gates with the release owner. Remove unreleased changes and replace internal implementation details with the effect customers will observe.
  5. Copy the reviewed notes into your publishing workflow. Keep source references in the review copy so engineering can check technical claims before publication.

For example, an implementation note about adding HTTP 429 to a retry predicate could become: “Webhook deliveries now retry after a rate-limit response, honoring the destination’s Retry-After header.” This illustrative wording is suitable only after the implementation and release owner confirm both behaviors and availability.