How to Write Release Notes?

Release Notes cover what's new, download and installation instructions, known issues and frequently asked questions. Creating Release Notes is fairly straightforward. Create a Release Notes template and re-use it on each release.

The template should include some of the following sections:

• Release note identifier (name, date, version #)

• What's New

• System Requirements (third-party platforms / modules / etc with version numbers / dates)

• Features and changes (new features, defects corrected, caveats etc)

• Outstanding issues (unresolved defects, workarounds, installation issues etc)

• Installation guide (how to obtain and install)

• Known Issues

• Troubleshooting

• FAQ

• Other Resources and Links

Whenever a new software version is released, a Release Note is generated to provide the necessary information about bug fixes, new features, workarounds, known issues etc.

In many cases, two release notes are required:

• Internal release note provided for the company’s own use.

• Public release note provided for customers and end users

Release notes are documents which are distributed along with software products, often when the product is still in the development or test state (e.g., a beta release).

For products that have already been in use by clients, the release note is a supplementary document that is delivered to the customer every time a bug is fixed or an enhancement is made on the product.

Our Release Notes package includes 2 pre-formatted templates in MS Word™ format, which can be easily modified to meet your next release.

Each template includes 17 pages of material including sections on Changes to release notes, Scope, System Requirements, New Features, Dropped Features, Fixed Issues, Hotfixes, Known Issues, Limitations & Restrictions, Caveats, and Deployment Instructions.

Please see the Table of Contents below.

Screenshots

Release notes template #1 cover page

Document History

About these Release Notes

Chapter 1, Introduction

Chapter 2, System Requirements

Chapter 8, Deployment Instructions

Release Notes - Table of Contents TOC

1. Introduction
1.1. Changes to the release notes
1.2. Scope

2. System Requirements
2.1. Operating systems supported
2.2. System requirements

3. New Features

4. Dropped Features

5. Fixed Issues
5.1. Included Hotfixes
5.2. Included maintenance fixes

6. Known Issues, Limitations & Restrictions
6.1. Known Issues
6.2. Limitations
6.3. Restrictions

7. Caveats

8. Deployment Instructions
8.1. <Item 1> – Deployment Instructions
8.2. <Item 2> – Deployment Instructions
8.3. <Item 3> – Deployment Instructions

9. Related Documentation
9.1. Obtaining Documentation


How to use this Release Notes template

1. How to use this template
1.1. How to add your logo to the cover page
1.2. How to change [COMPANY] to your company name
1.3. How to add your logo to the header
1.4. Updating the Table of Contents
1.5. Adding Notes
1.6. Adding Warnings
1.7. Adding Comments
1.8. Bullet Lists
1.9. Numbered List
1.10. Sample Tables

What's included in the template pack

All templates are in Microsoft Word format and can be downloaded online for only $7.99.

The template pack includes the following documents:

Release Notes Template #1	17 pages
Release Notes Template #2	17 pages
Document Control Spreadsheet	1 spreadsheet

Download Now for $7.99- Buy Here!

60-day Money-Back Guarantee

Secure Online Order Form

Supports Windows 98, Me, 2000, 2003, XP, Vista. 

* Note: All prices are in US$ and for a single user license.

Q: What file formats are the templates?

A: Microsoft Word and Microsoft Excel. 

Q: How soon can I download them?

A: You can download the files instantly. After you pay online, you are automatically sent to a page where you can download the template online.

A: You can read the License Agreement here

Get more Word Templates

Need to know more?

Drop me a line at ivan at klariti dot com and I'll get back to you asap.