Release notes

From HandWiki
Short description: Document listing software changes

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 release).[1][2] 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 or Release logs or Software changes or Revision history Updates or README file.[3] 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.[4][5]

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.[6]

Content

Release notes detail the corrections, changes or enhancements (functional or non-functional) made to the service or product the company provides.[7][8][9]

They might also be provided as an artifact accompanying the deliverables for System Testing and System Integration Testing and other managed environments especially with reference to an information technology organization.

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 implementer of the change to conduct rudimentary acceptance tests.

They differ from End-user license agreement, 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.[10]

Release notes can also be interpreted as describing how to install or build the software, instead of highlighting new features or resolved bugs.[11] 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, anti-piracy, duplication etc.. See also disclaimer.
  • 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 guides. 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.[12]

Prominent examples (mainly software)

The following list is a selection of major software from different branches, such as software games, operating systems, automotive, CAD design, etc.

See also

Further reading

  • Laura Moreno et al. ARENA: An Approach for the Automated Generation of Release Notes, IEEE Transactions on Software Engineering (Volume: 43, Issue: 2, Feb. 1 2017)[14]
  • Casey Newton. I drank beer and wrote release notes with the Medium release notes team, The Verge (2016-02-10)[15]
  • GNU coding standards - 6.8 Change Logs

References

  1. ↑ "Change Log Concepts (GNU Coding Standards)". https://www.gnu.org/prep/standards/html_node/Change-Log-Concepts.html#Change-Log-Concepts. 
  2. ↑ Scott, James (2020-04-24). "The art of writing great release notes" (in en). https://uxdesign.cc/the-art-of-writing-great-release-notes-6607e22efae1. 
  3. ↑ "Releases (GNU Coding Standards)". https://www.gnu.org/prep/standards/html_node/Releases.html#index-README-file. 
  4. ↑ "Version History - English - Knowledge Base". https://kb.i-doit.com/display/en/Version+History. 
  5. ↑ "56508 - Zynq-7000 SoC, 14.6 FSBL - Is there a changelog?". https://support.xilinx.com/s/article/56508?language=en_US. 
  6. ↑ Hobbs, Brian; Besner, Claude (2016-05-01). "Projects with internal vs. external customers: An empirical investigation of variation in practice" (in en). International Journal of Project Management 34 (4): 675–687. doi:10.1016/j.ijproman.2016.02.010. ISSN 0263-7863. 
  7. ↑ "Change Logs (GNU Coding Standards)". https://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs. 
  8. ↑ Wang, C.; Li, J.; Liang, P.; Daneva, M.; Sinderen, M. (September 2019). "Developers' Eyes on the Changes of Apps: An Exploratory Study on App Changelogs". 2019 IEEE 27th International Requirements Engineering Conference Workshops (REW). pp. 207–212. doi:10.1109/REW.2019.00042. ISBN 978-1-7281-5165-6. https://ieeexplore.ieee.org/document/8933541. 
  9. ↑ Bourne, Kelly C. (2014-01-01), Bourne, Kelly C., ed., "Chapter 10 - Updates and Patches" (in en), Application Administrators Handbook (Boston: Morgan Kaufmann): pp. 150–165, doi:10.1016/b978-0-12-398545-3.00010-8, ISBN 978-0-12-398545-3, https://www.sciencedirect.com/science/article/pii/B9780123985453000108, retrieved 2021-03-25 
  10. ↑ release-notes/release-notes-spec, Release Notes, 2021-03-25, https://github.com/release-notes/release-notes-spec, retrieved 2021-03-25 
  11. ↑ "Linux kernel release 5.x — The Linux Kernel documentation". https://www.kernel.org/doc/html/latest/admin-guide/README.html. 
  12. ↑ release-notes/release-notes-spec, Release Notes, 2021-03-25, https://github.com/release-notes/release-notes-spec, retrieved 2021-03-25 
  13. ↑ "Releases · GitLab.org / GitLab" (in en). https://gitlab.com/gitlab-org/gitlab/-/releases. 
  14. ↑ Moreno, L.; Bavota, G.; Penta, M. D.; Oliveto, R.; Marcus, A.; Canfora, G. (February 2017). "ARENA: An Approach for the Automated Generation of Release Notes". IEEE Transactions on Software Engineering 43 (2): 106–127. doi:10.1109/TSE.2016.2591536. ISSN 1939-3520. 
  15. ↑ Newton, Casey (2016-02-10). "I drank beer and wrote release notes with the Medium release notes team" (in en). https://www.theverge.com/2016/2/10/10938420/medium-release-notes-drinking. 

External links



Retrieved from "https://handwiki.org/wiki/index.php?title=Release_notes&oldid=3365003"