Release Notes: Sample Text for Writing Enhancements

release-notes

An enhancement is a new feature, or an improvement to a current feature, included in the current release.

To help the reader understand the enhancement, describe:

  • Where the enhancement is located in the user interface.
  • What parameters need to be configured.
  • What is the default setting.
  • Why you should use this enhancement, for example, a business benefit, productivity improvement, or the ability to perform a new task.
  • How the enhancement affects other screens, windows, or modules.

In addition to this, identify any files affected, such as DLLs, XSD schema files, or configuration files.

If you’ve updated user guides or other technical documents, highlight these under Books Affected.

Sample Text for Release Notes Enhancement

Enhancement for Communications Broker Service

Sending Methods to Non-API Threads

Bug# 12345

It is now possible to send SOA methods to non-API threads.

A new parameter, SendJobToApi, sends SOA methods to non-API threads.

  • True – SOA methods are not sent to non-API threads.
  • False – SOA methods are sent to non-API threads. This is the default.

Files affected: Fpml.dll, CommsBroker.dll, Service.xsd

Book affected: Administration Guide

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