JIRA Microsoft Word release notes template

Download Template Sample PDF

This free example template for the Intelligent Reports for JIRA plugin creates release notes for any version of any project in Atlassian JIRA. This template separately lists new features and bugs included with the release, giving both the issue key and summary. It also automatically includes details about the project and version and has locations for you to add a release summary and usage/installation guides.

As with all Intelligent Reports templates the release notes template is customizable in Microsoft Word to allow you to insert your company branding and customize the data that is exported into the template. In addition, since the release notes are generated as a Microsoft Word docx document you can easily customize the release notes after generation, making it easy to add release summaries, special instructions or any other content that is required.

Using a template gives professional, accurate release notes, all while saving time in one of the most time critical phases of development. In addition the template can be used for release policy enforcement in JIRA, for instance by default the release notes will not generate until the version is marked as released in JIRA.

The release notes report template is included when you first install the Intelligent Reports plugin for JIRA.

Customization

We have limited this template to the default issue types and fields in JIRA so that it will work immediately for everyone. Here are a few ideas for customizing the template, none of which should take you more than a few minutes:

• Brand the template with your company logo and style. Simply open the template .docx file and format it in Microsoft Word.
• Create a "customer visible" custom field on your issues in JIRA, and use this in the JQL queries for the release notes to only include appropriate issues
• Add an ordering to the JQL queries to order the issues in the list as you prefer
• Add additional fields to the issues in the release notes appropriate to your audience, for example issue severity
• Customize the bug and feature lists to your own JIRA workflow. Add new lists if desired.