Create and Schedule Your Release Notes
Keeping everyone informed about product updates is a great way to build trust and excitement. This guide will walk you through how Solo helps you create, configure, and even automate your release notes.
Why Write Release Notes?
There is no information on the importance of writing release notes.
How Solo Gathers Information for Release Notes
To create accurate and relevant release notes, Solo analyzes the changes made to your product's code over a specific period. Here’s how it works:
Analyzes Code Changes: Solo looks at the differences in your code between a start and end date across all your connected code repositories.
Identifies Product Updates: It intelligently scans these changes to find updates that are relevant to your users, focusing on new features or significant modifications.
Applies Your Style: Solo uses any custom voice, guidelines, or templates you've set up to ensure the release notes match your company's tone and format.
Setting Up and Generating Release Notes
You have full control over the style of your release notes and when you create them.
Configure Your Release Notes Style
You can set up specific guidelines and templates for all your release notes to maintain a consistent voice and format.
Go to Account Settings.
Select the Configuration tab.
Find the Configure Release Notes section.
Here, you can add:
Voice/Guidelines: Instructions on the tone and style Solo should use.
Templates: A specific format or structure for Solo to follow.
Manually Create a Release Note
When you're ready to announce a new batch of updates, you can generate a release note manually.
Navigate to the Release Notes section and create a new release note.
Choose a start date for the period you want to cover. You can select from:
Since last release
One week ago
A custom date
Once the release note is created, click Generate to have Solo write the content for you.
Schedule Automatic Release Notes
Save time by scheduling your release notes to be generated automatically.
In the Release Notes section, open the schedule settings.
Set a start date for when you want the schedule to begin.
Choose how often you want release notes to be generated. The available frequencies are:
Weekly
Every two weeks
Every three weeks
Monthly
Once you set a schedule, Solo will handle the rest, automatically creating new release notes for you at your chosen interval.