Release notes are documents that are distributed with software products or hardware products, sometimes when the product is still in the development or test state (e.g., a

beta Beta (, ; uppercase , lowercase , or cursive ; or ) is the second letter of the Greek alphabet. In the system of Greek numerals, it has a value of 2. In Ancient Greek, beta represented the voiced bilabial plosive . In Modern Greek, it represe ...

release). For products that have already been in use by clients, the release note is delivered to the customer when an update is released. Another abbreviation for Release notes is ''

Changelog A changelog (also spelled change log) is a log or record of all notable changes made to a project. The project is often a website or software project, and the changelog usually includes records of changes such as bug fixes, new features, etc. Som ...

'' or ''Release logs'' or ''Software changes'' or ''Revision history'' ''Updates or README file''. However, in some cases, the release notes and changelog are published separately. This split is for clarity and differentiation of feature-highlights from bugs, change requests ( CRs) or improvements on the other side.

Purpose

Release Notes are documents that are shared with end users, customers and clients of an organization. The definition of the terms 'End Users', 'Clients' and 'Customers' are very relative in nature and might have various interpretations based on the specific context. For instance, the Quality Assurance group within a software development organization can be interpreted as an internal customer.

Content

Release notes detail the corrections, changes or enhancements ( functional or non-functional) made to the service or product the company provides. They might also be provided as an artifact accompanying the deliverables for

System Testing System testing, a.k.a. end-to-end (E2E) testing, is testing conducted on a complete software system. System testing describes testing at the system level to contrast to testing at the system integration, integration or unit level. System t ...

and

System Integration Testing System integration testing (SIT) involves the overall testing of a complete system of many subsystem components or elements. The system under test may be composed of electromechanical or computer hardware, or software, or hardware with embed ...

and other managed environments especially with reference to an

information technology Information technology (IT) is a set of related fields within information and communications technology (ICT), that encompass computer systems, software, programming languages, data processing, data and information processing, and storage. Inf ...

organization. Release notes can also contain test results and information about the

test procedure Test(s), testing, or TEST may refer to: * Test (assessment), an educational assessment intended to measure the respondents' knowledge or other abilities Arts and entertainment * Test (2013 film), ''Test'' (2013 film), an American film * Test ...

. This kind of information gives readers of the release note more confidence in the fix/change done; this information also enables implementer of the change to conduct rudimentary acceptance tests. They differ from

End-user license agreement An end-user license agreement or EULA () is a legal contract between a software supplier and a customer or end-user. The practice of selling licenses to rather than copies of software predates the recognition of software copyright, which has ...

, since they do not (should not) contain any legal terms of the software product or service. The focus should be on the software release itself, not for example legal conditions. Release notes can also be interpreted as describing how to install or build the software, instead of highlighting new features or resolved bugs. Another term often used in this context is ''System Requirements'', meaning the required hardware and software for installing or building the software.

Format style

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: * Header – Document name (i.e. release notes), product name, release number, release date, note date, note version, etc. * Overview - A brief overview of the product and changes, in the absence of other formal documentation. * Purpose - A brief overview of the purpose of the release note with a listing of what is new in this release, including bug fixes and new features. ** Issue summary - A short description of the bug or the enhancement in the release. ** Steps to reproduce - The steps that were followed when the bug was encountered. ** Resolution - A short description of the modification/enhancement that was made to fix the bug. * End-user impact - What different actions are needed by the end-users of the application. This should include whether other functionality is impacted by these changes. * Support impacts - Changes required in the daily process of administering the software. * Notes - Notes about software or hardware installation, upgrades and product documentation (including documentation updates) * Disclaimers - Company and standard product related messages. e.g.;

freeware Freeware is software, often proprietary, that is distributed at no monetary cost to the end user. There is no agreed-upon set of rights, license, or EULA that defines ''freeware'' unambiguously; every publisher defines its own rules for the free ...

anti-piracy Anti-piracy may refer to: * Anti-piracy measures Piracy is an act of robbery or criminal violence by ship or boat-borne attackers upon another ship or a coastal area, typically with the goal of stealing cargo and valuable goods, or taking ...

, duplication etc.. See also

disclaimer A disclaimer is generally any statement intended to specify or delimit the scope of rights and obligations that may be exercised and enforced by parties in a legally recognized relationship. In contrast to other terms for legally operative langua ...

. * Contact - Support contact information. 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 guide A user guide, also commonly known as a user manual, is intended to assist users in using a particular product, service or application. It is usually written by a technician, product developer, or a company's customer service staff. Most user gu ...

s. Release notes are frequently written in the present tense and provide information that is clear, correct, and complete. A proposal for an open-specification exists and is called Release Notes Schema Specification.

References

External links

How to write release notes

How should release notes be written?
(Stackoverflow)
The Strange Art of Writing App Release NotesRelease Notes Hub
(also https://www.release-notes.com) ''open-source'' on GitHub
Release Notes Schema Specification
Technical communication Software release Configuration management Change management

Purpose

Content

Format style

See also

Further reading

References

External links