From Wikipedia, the free encyclopedia - View original article
|This article does not cite any references or sources. (December 2009)|
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.
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 should be written by a Project Development Lead or Project Manager or even by technical writer. 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.
There is no standard format for release notes that is followed throughout different organizations. Organizations normally adopt their own formatting styles based on the requirement and type of the information to be circulated. The content of release notes also vary according to the release type. For products that are at testing stage and that are newly released, the content is usually more descriptive compared to release notes for bug fixes and feature enhancements, which are usually brief. Release notes may include the following sections:
A release note is usually a terse summary of recent changes, enhancements and bug fixes in a particular software release. It is not a substitute for user guides. Release notes are frequently written in the present tense and provide information that is clear, correct, and complete.
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:
- 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