Publish your first release note

Publish and share your latest product updates with multiple stakeholders

How to Create & Publish a release note from

1. Create & Publish Release Notes

Once the module has been toggled ON;

  1. Head over to the Execution section from the left navigation menu and click on Release notes from the sub-menu.
  2. This is where you will be able to create and view all published Release notes.
  3. Click on Add Release Notes to begin writing about your latest release.
  4. The process is divided into three steps:
    1. Create Release Notes
      1. You will get a popup to select the template, where you be able to Use Template out of the four choices provided or you can choose to Create from scratch

        Screenshot 2022-07-12 at 12.17.42 PM

      2. From there, you will be taken to a new screen where you will be able to add specific details such as the
        1. Title - Main heading of your release note. It can be anything. Few examples:
          Here are some recent upgrades we shipped in July!
          July 2022 Updates 
          Fixed major bugs for payment transactions with this week's release!
        2. Description - This s where the main content goes. Use 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.
        3. (Optional) Categories - 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.
        4. (Optional) Tags - Map your release notes with different tags which can be used for the search purpose in the Release notes list.
        5. (Optional) Published On - Published on a date can be either the present date or a past date. This will help users to keep a consistent frequency of release for their customer's understanding. 
        6. (Optional) Add Author - 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.
        7. (Optional) Cover image - 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.

          Screenshot 2022-07-12 at 12.18.12 PM

    2. Select Users & Channel
      1. Slack: If your slack is integrated, you can share release notes with internal team members on any slack channel.
      2. Email: You can share release updates with your team members and external stakeholders using email. This option allows you to send it to:
        1. All Users = workspace members + Users (under Customers)
        2. Select Audience
          1. Workspace members 
          2. External users (Customers)
            1. All Customers
            2. Custom
              1. Select segments - select users basis their organization segment, useful to select multiple users directly through segment tag
              2. Select users - select users directly from the list, useful to ensure important users receive the email
      3. Customer Portal and widget: If the customer portal and widget are enabled, then the release note will be visible on these channels respectively. This can be switched on-off after publishing as well.

        Screenshot 2022-07-12 at 12.18.29 PM

    3. Preview & Publish
      1. After details are added and users are selected, check the Preview to get the look and feel once published.
      2. Once everything is set, hit Publish.

        Screenshot 2022-07-12 at 12.18.44 PM

The release note is published successfully! 

To know more about this refer to the article here.