Release Notes: How to Write Enhancements

Want to improve the quality of the enhancements in your Release Notes? Here are seven ways.

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

Enhancement Identifier

Provide the reference number for the enhancement, such as Salesforce 12345.

Business value

Describe the benefit to the user if they use this enhancement.

Usually, there is a specific business driver or customer request behind each enhancement’s development. Describe this in one or two sentences.

Encourage the reader to try the new feature. If the default setting means the new feature is not displayed, then highlight that they need to change a parameter settings or some other configuration.

Location

Identify where the enhancement is displayed in the user interface.

If necessary, identify or describe any specific steps required to access this screen. Don’t make the reader work to find out where the new feature is located.

Identify the window, dialog box, or web page where they can examine it. Also, if finding it is not intuitive, help them by providing a short reminder on how to find the screen.

Configuration settings

Most new features come with new configuration settings or parameters that need to be modified. If necessary, describe the configuration settings that need to be modified to use the new enhancement. State where this is located and the default settings.

Highlight any impact using this new feature may have on other settings, windows, or data, for example, changes in reports, user access, or performance.

Files affected

List the files affected by the update as consultants may need to be aware of this. Highlight if they have to rebuild a DLL or recompile a file to use the new feature.

Books affected

Identify where the user can learn more about this area, for example, the User Guide or Installation manuals.

Enable v Allow

Be clear when using these words.

In general, allow relates to access rights. For example, this enhancement allows you (i.e. with these access rights) to perform this specific task.

Enable relates to new functionality, for example, this window enables you to create reports for hedge accounting. In other words, you now have the ability to create hedge accounting reports.

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