Release notes

Release notes are documents that are distributed 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 when a bug is fixed or an enhancement is made to the product.

Purpose and Responsibilities

Release notes are communication documents shared with customers and clients of an organization detailing the changes or enhancement made to the features of service or product the company provides. Thus this communication document is usually circulated only after the product or service is thoroughly tested and approved against the specification provided by the development team.

Release notes may be written by a technical writer or any other member of the development or test team. Release notes can also contain test results and information about the test procedure. This kind of information gives readers of the release note more confidence in the fix/change done; this information also enables implementers of the change to conduct rudimentary acceptance tests. Release notes are also an excellent mechanism to feed the process of end user documentation; user guides, marketing materials, and revisions to training materials.

Format

Usually release notes are written in this format. +es for additions to the program, -es for removals, and *s for fixes and miscellaneous changes.

Here is an example:

Version 1.X.X

- Removed ability to fly without pref.godmode being true (the glitch was only on multiplayer)

+ Added expansions to the lighting engine

* Changed the way that pistons work

- Removed Herobrine

See also

• Changelog