Glossary · Automation software engineering and architecture
Release note
Also known as: Release notes, Change log
German: Freigabehinweis
In software and product documentation, a release note is a document delivered with a release that describes what changed compared with the previous version, including new features, fixed defects, known issues, compatibility information and required actions.
- Software engineering
- Technical documentation
In one sentence
A release note describes what changed in a release: new features, fixed defects, known issues, compatibility and required actions.
Example
The release note for PLC library 3.0.0 lists the renamed parameters, explains how to migrate existing projects and names the minimum firmware version required.
How it applies
- Documentation: Release notes are written for users, not developers: what changes for them and what they must do. Typical sections are new features, changes, fixed issues, known issues, compatibility and upgrade instructions. In DITA, each entry can be a small topic reused in the manual.
- Engineering: Linking release note entries to tickets or pull requests makes them traceable and easier to compile. Commit messages alone are rarely suitable for users.
- Maintenance: Operators and integrators use release notes to decide whether to update. Security fixes and a Breaking change must be stated clearly.
Release note vs. change log
A change log is often a complete, technical list of changes for developers. A release note selects and explains what matters to users of the release.