Writing Guidelines For Release Notes Enhancements

What do you need to include in your enhancement release notes?

Download: Release Notes template package with 2 pre-formatted templates in MS Word.

Download Now for $7.99- Buy Here!

Download Template

Learn more about these Release Notes Templates

At a minimum, you need to cover the following:

  1. Description – identify the new enhancement. Avoid the words new, enhancement, or feature in the title. You can drop these words as it’s implied that it’s an enhancement as it’s in the Enhancement section of the release notes.
  2. Tracking number – include this so customers can track their enhancement. Many customers will request an enhancement and use this number to see if it appears in the release.
  3. Feature – describe the nature of the enhancement. What can the user do?
  4. Location – identify where it’s located in the software or web application. What screen or dialog box? Do they need to modify a parameter to see it? If so, where?
  5. Settings – how do they configure the settings?
  6. Default value – what are the default values, usually, True, False, Yes, or No.
  7. Language – write in the present tense. This feature is now available etc.

When you write bugs, state what happened before it was fixed.

When you write enhancements, state what is now available.

Sample Release Notes text

Here’s an example of a generic release note enhancement.

A new feature, NewFeature, has been added to the Designer window.

The following settings are available:

  • Yes – specifies that the new feature is displayed on the Designer
  • No – specifies that the new feature is not displayed on the Designer The default value is No.

Enhancements Release Notes Guidelines

To recap, what we’ve done here is:

  • Identified the new feature.
  • Stated where it appears, or is located. This helps the developer or tester find the setting in the user interface, configuration file, or XML file.
  • Describe the different settings. Help the developer understand what happens if they choose one of these settings. Most of the time it is obvious but highlight exceptions or additional information they should be aware of. For example, if they change a setting, and it affects another window or setting, then write this down.
  • Identify the default value. In this example, the new feature is not displayed unless you decide to turn it on.

Download: Release Notes template package with 2 pre-formatted templates in MS Word.

Download Now for $7.99- Buy Here!

Download Template

Learn more about these Release Notes Templates

Download these templates to start

Acceptance Test Plan

Contingency Plan

Software Development Templates

Acquisition Plan

Conversion Plan

Software Requirements Specification

Action Plan

Cost Benefit Analysis

Software Testing

API Documentation

Database Design

Standard Operating Procedures (SOP)

Audience Analysis

Datasheet

Statement of Work

Availability Plan

Deployment Plan

System Administration Guide

Bill of Materials

Design Document

System Boundary

Business Case

Disaster Recovery Plan

System Design Document

Business Continuity

Disposition Plan

System Specifications

Business Plan

Documentation Plan

Technical Writing Templates

Business Process

Employee Handbook

Test Plan

Business Requirements

Error Message Guide

Training Plan

Business Rules

Expression of Interest

Transition Plan

Capacity Plan

Fact Sheet

Troubleshooting Guide

Case Study

Feasibility Study

Use Case

Change Management Plan

Functional Requirements

User Guide

Communication Plan

Grant Proposal

Verification and Validation Plan

Concept of Operations

Implementation Plan

White Papers

Concept Proposal

Installation Plan

Work Instructions

Configuration Management Plan

Interface Control Document

Software Development Templates

Acceptance Test Plan

Maintenance Plan

Software Requirements Specification

Acquisition Plan

Market Research

Software Testing

Action Plan

Marketing Plan

Standard Operating Procedures (SOP)

API Documentation

Needs Statement

Statement of Work

Audience Analysis

Operations Guide

System Administration Guide

Availability Plan

Policy Manual

System Boundary

Bill of Materials

Project Plan

System Design Document

Business Case

Proposal Manager Templates

System Specifications

Business Continuity

Proposal Template

Technical Writing Templates

Business Plan

Quality Assurance Plan

Test Plan

Business Process

Release Notes

Training Plan

Business Requirements

Request for Proposal

Transition Plan

Business Rules

Risk Management Plan

Troubleshooting Guide

Capacity Plan

Scope of Work

Use Case

Case Study

Security Plan

User Guide

Change Management Plan

Service Level Agreement (SLA)

Verification and Validation Plan

Communication Plan

Setup Guide

White Papers

Concept of Operations

Social Media Policy

Work Instructions

Concept Proposal

Contingency Plan

 

Configuration Management Plan

Conversion Plan