📌 A release note is a document that is published along with your product releases to explain to your users the changes that have been made to the product.
Why is it important?
This enables the customers to better understand the changes you have made to the product and how to use them in their use case. Internal teams can also stay on track with product developments and will be better able to serve customers when they understand the product.
How to Create and Preview a Release Note using Zeda.io?
👉 Head over to the Release note section from the left navigation menu.
👉 This is where you can create and view all published Release notes.
👉 Click on Add Release Notes to begin writing about your latest release.
There are 3 ways to create “Release Notes” using Zeda.io once you click on “Create Release Note” in the top right corner.
You can choose to use the “Start from Scratch” option, where once you click "Create Release Note," you can begin crafting the release note entirely from the ground up, including adding your own release note title and content.
The next option is to Create a release note using the “Generate Release Note with AI” option.
For more detailed information on How to Generate Release notes with AI, please refer to this link: How to Generate Release note using AI
The last option to write a Release note is to use the “Templates” provided. There are four different templates that can be used according to your timelines for publishing a release note.
Traditional Template: You can use this template and edit the changes accordingly. All the new features added or bugs improved.
Traditional Template: You can use this template and edit the changes accordingly. All the new features added or bugs improved.
Time-Based (Weekly) Template: This template can be used if you are doing weekly updates and sending release notes every week.
Time-Based (Weekly) Template: This template can be used if you are doing weekly updates and sending release notes every week.
Monthly-Based Template: This template can be used if you are doing weekly updates and sending release notes every month and can be written accordingly.
Monthly-Based Template: This template can be used if you are doing weekly updates and sending release notes every month and can be written accordingly.
Tactical - Bug Fix template: Publish this release note only when any critical bug fixes are going live, and you must inform your users.
Tactical - Bug Fix template: Publish this release note only when any critical bug fixes are going live, and you must inform your users.
Once the release note is ready, you can also choose the category of the feature that will be released. To do so, you need to choose “Add Category” from the left upper corner and choose if it’s a bug, improvement, or new feature release. You can also add Tags and Add Authors to your release notes.
After completing your release note, you can also preview it. Once you click on “Preview” in the top right corner, you can send a test email. You can also check on how it will look on Desktop, mobile, or email.
📌 Some important specific details for your understanding:
Title - Main heading of your release note. It can be anything.
Examples: Recent upgrades we shipped in July!Fixed major bugs for payment transactions with this week's release!
Description - This is where the main content goes. Using the slash command, it is powered by the Zeda-editor which has lots of interesting styling and options to make release notes editing not a typical note taker.
Categories (Optional) - Differentiate context using various categories. This basically enables the readers to quickly gauge what the team has been working on in that particular release. By default, we provide the categories as New features, Improvements, and Bug fixes. However, you can easily edit these and set them up according to your preference from Workspace settings > Modules > Release notes > Categories.
Tags (Optional) - Map your release notes with different tags that can be used for the search purpose in the Release Notes list.
Published On (Optional) - Published on a date can be either the present date or a past date. This will help users keep a consistent release frequency for their customer's understanding.
Add Author (Optional) - Any creator or admin can be made an author.
Only authors can edit the release note. This can be used to add different product owners to collaborate better for release notes. There will always be at least 1 author in a release note.
Cover image (Optional) - This is where you add an image that captures the essence of this release. This will appear as the first image on the release note.