How to: Generate Release Notes from Agility

This feature is available in all editions

Overview

There are a few options for automatically generating Release Notes for your product.

Option 1: Story List - Title & Description

The most straightforward method to generate release notes and guarantee that you capture all the data is to provide a Story (Backlog Item) list with the associated descriptions as your release notes. You can generate the release notes by exporting the stories to Excel or using an API query, and ensure you have all the data contained. Just include the story title and description to provide a full accounting of what was done.

Option 2: Story List - Custom Text Field

If the story descriptions are not appropriate for external audiences, you can create specific custom fields on a story, defect, or test set and use them specifically to store the external-facing descriptions as appropriate. As described above, you can generate the release notes by exporting the stories to Excel or using an API query to help generate your final format.

Option 3: Release Description (Manual)

To manually create release notes along the way through the release, you can use the Description field of the release to store the contents. This is a simple method that simply gives you a single place to store the content. You can then view the History to ensure that the content that is entered will always be available.