Skip to main content

Release Notes Generator

Automatically generate clear, user-facing release notes and detailed internal change logs.

Jake Rosenthal avatar
Written by Jake Rosenthal
Updated over a week ago

What does this mean?

Streamlines the release process by providing polished, consistent communications for users and teams, reducing the burden on product managers and enhancing transparency.

How it works?

Automatically compiles and crafts clear, user-facing release notes and detailed internal change logs from development updates and ticket histories.

Workflow steps

Step 1: Trigger on new release or sprint completion

The Workflow activates when a sprint closes or release is tagged in Jira, or through a manual trigger when a product manager initiates the release notes process with relevant ticket IDs or version details.

Step 2: Pull development updates and ticket histories

Cassidy retrieves the relevant tickets, commits, and change records from your connected tools—gathering descriptions, labels, and resolution details that form the raw material for your release documentation.

Step 3: Generate user-facing release notes

Cassidy crafts polished, user-friendly release notes that translate technical changes into clear benefits and feature descriptions your customers will understand—drawing on your Knowledge Base for product terminology and brand voice.

Step 4: Generate internal change log

A detailed internal change log is created with technical specifics, ticket references, and implementation notes for engineering and support teams.

Step 5: Route for human review

Both documents are sent to a product manager or technical writer for quick review, edits, or approval—keeping a human in the loop before publication.

Step 6: Export and distribute

Once approved, the Workflow exports the release notes as a Microsoft Word document or sends them via email to stakeholders, and can push updates to your documentation platform or internal wiki for full visibility.

Did this answer your question?