Welcome to Solo! A great first step is to see how easy it is to communicate product changes to your team and customers. This guide will walk you through creating your first set of release notes, which are summaries of recent updates and new features.
Why Generate Release Notes?
Keeping everyone in the loop about product updates is essential. Release notes translate the technical work your engineering team does into easy-to-understand updates for everyone else.
Generating these notes directly from your codebase ensures that:
They are accurate: The notes are based on the actual changes made, so nothing gets missed.
They save time: It automates the process of tracking and summarizing updates.
They are easy to understand: The information is written for a non-technical audience, making it clear and accessible for any team member or customer.
How to Generate Your Release Notes
Follow these simple steps to create and generate your first report.
Create a New Release Note
From the main navigation, go to the Release Notes page.
Click the Generate New Release Notes button.
A dialog will appear asking you to set a start date for the period you want to cover.
Choose Your Start Date You have a few options to define the timeframe for your notes:
One week ago: Captures all changes from the last seven days.
Since last release: Automatically uses the end date of your most recent release note as the start date.
Custom: Allows you to pick a specific start date from a calendar.
Generate the Content
After selecting your start date, click Create. You'll be taken to a new page for your release note.
On this page, click the Generate Release Note button.
Solo will now analyze the changes made since your selected start date and begin writing the content for you. You can watch as the notes appear on your screen.
What to Do Next
Once your release notes are ready, you can easily share them.
Copy to Clipboard: Use the "Copy to Clipboard" button to copy the notes. This copies them in a rich text format, so you can paste them directly into emails, documents, or other tools while keeping the formatting intact.
Regenerate if Needed: If you want to generate the notes again, simply click the "Regenerate" button.
Helpful Tips
Clear and Concise: The generated notes are designed to be straightforward and free of technical jargon.
Grouped by Feature: Related updates are automatically grouped together under a single changelog to make the notes easy to read and digest.
Just the Facts: The output is designed to be concise and avoid unnecessary fluff, focusing only on the changes made.