Specify a type to organize your release notes.

Specify the version of the product described by this release note.

Name the product and provide a link to further information for this product.

Specify the date the product was released.

List the stakeholders that take special interest in this release or are specially involved in this released version.

Describe the purpose of this release notes document.

You may add also information about the product to help readers to determine, if this document is relevant for them.

List the main features of this release and the most important information for users to decide whether to select this version or not. This is usually about three paragraphs long.

List requirements for the new version of the product.

Describe changes that remove or break existing features that require the users attention.

List known issues with this release and provide workarounds and links to track the issues.

Provide information on how to install this release. If these instructions do not differ from previous release you may simply reference the installation instructions from here. This helps users to quickly access them. You may also want to provide links to the user manuals or getting started guides.

 Provide information on how to upgrade to this release. This may include creating a backup of personal data or migration instructions.

If the JIRA server is configured, this section lists the issues associated with this version of the product.

The query to select the issues is based on the version property of the release note.

project = 'MY_PROJECT_NAME' && fixVersion = 'MY_VERSION' ORDER BY type DESC, priority DESC

The Release Note Type allows to group release notes for your products and services.