Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt
hiddentrue

Examples of release notes and documentation provided for specific software releases, and templates you can use to create your own release notes.


Master wrapper
PageTypeTopic
Software Release Notes Documentation and Templates


Perspectives on Software Release Notes Documentation and Templates

Promoted link

List wrapper


List item
L;www.guru99.com;Release Procedures For Purchasing Documents;http://www.guru99.com/release-procedures-for-purchasing-documents.html;NA;2016;;;


 


Templates and Guidelines


List wrapper


List item
recommendedtrue
L;sitepoint.com;How to Write (Better) Release Notes in 7 Steps;https://www.sitepoint.com/write-better-release-notes/;NA;NA;;;For some businesses, release notes are the only way product enhancements are communicated to customers. For others, they're a sideline, developed entirely separately from user communications. But if you want to do more with less - if you want to improve customer retention communications without having to do a stack more work - your release notes could be an unexpected, but valuable answer.


List item
linkImagehttps://i-cdn.embed.ly/1/display/resize?key=fd92ebbc52fc43fb98f69e50e7893c13&url=http%3A%2F%2Fwww.ihearttechnicalwriting.com%2Fwp-content%2Fuploads%2F2015%2F02%2Frelease-notes-how-to-write.gif&width=175
recommendedtrue
L;ihearttechnicalwriting.com;How to Write Release Notes: Faster, Stronger, Better - Template and Explanation;http://www.ihearttechnicalwriting.com/write-release-notes/;NA;NA;;;So, you want to write release notes but don't know where to start? Well pull you a chair and let me give you the lowdown. Here's what you need to know, grasshopper.


List item
linkImagehttps://i-cdn.embed.ly/1/display/resize?key=fd92ebbc52fc43fb98f69e50e7893c13&url=http%3A%2F%2F2.gravatar.com%2Favatar%2Fe4ee297e41088169a185c4f975f79998%3Fs%3D49%26d%3Dmm%26r%3Dg&width=175
L;blog.davingranroth.com;How to write a release notes document with clarity and brevity;http://blog.davingranroth.com/2010/03/how-to-write-release-notes/;Davin Granroth;NA;;;I confess, I'm a release notes reader, and I've read some overwrought release notes lately. When you use them like an installation guide, a features list, or a list of software conflicts, you've got it wrong. The purpose of release notes is simple: Release notes explain what changed with this version of your software. Period. I hope this article will help you write release notes with clarity and brevity.


List item
L;wikihow.com;How to Prepare Release Notes;http://www.wikihow.com/Prepare-Release-Notes;NA;NA;;


List item
L;sqa.stackexchange.com;Release Notes Best Practices;http://sqa.stackexchange.com/questions/2856/release-notes-best-practices;NA;NA;;


List item
L;klariti.com;Release Notes;http://www.klariti.com/release-notes-templates/how-to-create-release-notes.shtml;NA;NA;;


List item
L;wiki.openbravo.com;ERP 2.50:Release Notes Template on OpenbravoWiki;http://wiki.openbravo.com/wiki/ERP_2.50:Release_Notes_Template;NA;NA;;


List item
L;doit.maryland.gov;Version Description Document (VDD) - Configuration Control Document used to Track Versions of Software to be Released to Operational Environment;http://doit.maryland.gov/sdlc/documents/version_desc_doc.doc;NA;NA;;


List item
L;klariti.com;klariti Release Notes Template Package;http://klariti.com/release-notes-templates/;NA;NA;;


List item
L;opensdlc.org;SDLC Release Notes Template;http://opensdlc.org/support-files/SDLC-RUP-Release-Notes.pdf;NA;NA;;


List item
L;techwhirl.com;Release Notes Template;http://techwhirl.com/release-notes-template/;NA;NA;;


List item
L;template.net;Release Notes Template - 9 Free Word, PDF Documents Download;https://www.template.net/business/word-templates/release-note-template/;NA;NA;;


List item
L;projectconnections.com;Software Release Life Cycle Scope Definition Template;http://www.projectconnections.com/templates/detail/software-release-lifecycle-phase2.html;NA;NA;;


List item
L;sitepoint.com;How to Write (Better) Release Notes in 7 Steps;http://www.sitepoint.com/write-better-release-notes/;NA;NA;;;


List item
L;seguetech.com;The Benefit of Software Release Notes and Why Your Company Should Use Them;http://www.seguetech.com/blog/2013/03/13/benefit-software-release-notes-company-should-use;NA;NA;;;


List item
L;pm.stackexchange.com;Release Notes Best Practices;http://pm.stackexchange.com/questions/5183/release-notes-best-practices;NA;NA;;;



Examples of Release Notes and Documentation


List wrapper


List item
recommendedtrue
L;electric-cloud.com;Electric Cloud ElectricCommander 5.4 Software Release Notes;http://docs.electric-cloud.com/commander_doc/5_4/PDF/CommanderReleaseNotes_5_4.pdf;NA;NA;;;ElectricCommander 5.4 is a feature release (FR). Feature releases make available new features more frequently than relying on long-term support (LTS) releases (such as ElectricCommander 5.0). Electric Cloud aims for feature releases to be made available approximately every two months.


List item
recommendedtrue
L;msdn.microsoft.com;Release notes for Microsoft Release Management;https://msdn.microsoft.com/en-us/library/vs/alm/release/getting-started/release-notes;NA;2016;;;This topic describes the most recent features in Visual Studio Team Services. Due to differing release schedules, availability and behavior of some newer features may differ in Team Foundation Server (TFS).


List item
recommendedtrue
L;docs.oracle.com;Release Notes for Exalogic Elastic Cloud Software;http://docs.oracle.com/cd/E18476_01/doc.220/e18480/eecs.htm;NA;NA;;;<p>This section describes the new features and enhancements introduced in release 2.0.6 of the Exalogic Elastic Cloud Software (EECS).</p>


List item
linkImagehttps://i-cdn.embed.ly/1/display/resize?key=fd92ebbc52fc43fb98f69e50e7893c13&url=https%3A%2F%2Fassets.gentoo.org%2Ftyrian%2Fsite-logo.png&width=175
recommendedtrue
L;wiki.gentoo.org;Upgrading Gentoo - Gentoo Release Notes and Instruction Guide;https://wiki.gentoo.org/wiki/Upgrading_Gentoo;NA;2016;;;<p>This document explains how new Gentoo releases affect existing installs. Here in Gentoo land, the concept of upgrading is quite different compared to the rest of the Linux world. It is a well-known fact that Gentoo never got in touch with the "classic" way of upgrading software: waiting for a new release, downloading it, burning, putting it in the cdrom drive and then following the upgrade instructions.</p>


List item
recommendedtrue
L;haskell-servant.github.io;Haskell Servant 0.5 Released - Announcement, Documentation, Features List and Upgrade Guide;http://haskell-servant.github.io/posts/2016-03-19-servant-0.5-release.html;NA;2016;;;We're happy to announce the release of servant-0.5. Quite a lot of exciting changes have happened since the last major release. A lot of things happened under the hood, but there's also a number of changes on the surface. This will force servant users that want to upgrade to perform some changes to their code.


List item
L;blog.zimbra.com;Zimbra Collaboration 8.7.2 and 8.6 Patch 8 Are Available;https://blog.zimbra.com/2017/02/zimbra-collaboration-8-7-2-8-6-patch8-available/;NA;2016;;;In July of last year, we announced Zimbra Collaboration 8.7, which included four of my favorite, admin-related features including Two-Factor Authentication (2FA), a new Zimbra Packaging System, SSL Se


List item
L;v8project.blogspot.com;V8 JavaScript Engine - Release 5.7;https://v8project.blogspot.com/2017/02/v8-release-57.html;NA;2016;;;V8 continues to make ES2015 language features faster so that developers use new features without incurring performance costs. The spread operator, destructuring and generators are now approximately as


List item
L;pubs.vmware.com;VMware vRealize Automation Release Notes;http://pubs.vmware.com/Release_Notes/en/vra/vrealize-automation-625-release-notes.html;NA;2016;;;The release notes cover the following topics: This release of vRealize Automation contains some resolved problems as described in the Resolved Issues section, and the following: For information about


List item
L;koha-community.org;Koha 16.05.07 Release Notes;https://koha-community.org/koha-16-05-07-release/;NA;2016;;;03 Jan 2017 Koha is the first free and open source software library automation package (ILS). Development is sponsored by libraries of varying types and sizes, volunteers, and support companies from a


List item
L;www.bitovi.com;StealJS 1.0 Release Notes;https://www.bitovi.com/blog/stealjs-1.0-release;NA;2016;;;StealJS 1.0 is here and represents an important milestone along its mission. This article reiterates that important mission, goes over a few of 1.0's most useful features, explains how to upgrade for


List item
L;documentation.red-gate.com;DLM Automation 2.0 Release Notes;https://documentation.red-gate.com/display/DLMA2/DLM+Automation+2.0+release+notes;NA;2016;;;


List item
L;spring.io;Spring Integration 5.0 Milestone 1 Available;https://spring.io/blog/2016/12/02/spring-integration-5-0-milestone-1-available;NA;2016;;;


List item
L;duraspace.org;DSpace Release 6.0 Status;https://wiki.duraspace.org/display/DSPACE/DSpace+Release+6.0+Status;NA;2016;;;


List item
L;cwiki.apache.org;Apache NiFi Release Notes;https://cwiki.apache.org/confluence/display/NIFI/Release+Notes;NA;2016;;;


List item
L;versionone.com;Winter 2016 Release Notes;https://community.versionone.com/Release-Notes-and-Downloads/Winter_2016_Release_Notes;NA;2016;;;


List item
L;clearone.com;ClearOne CHAT Software Release Note;http://www.clearone.com/uploads/resource/801_000_017_00_RN_Rev1_1_CHAT_Software_Release_Notes-0.pdf;NA;NA;;


List item
L;cisco.com;Release Note for Cisco Wide Area Application Services (Software Version 5.5.5);http://www.cisco.com/c/en/us/td/docs/app_ntwk_services/waas/waas/v555/ws555xrn.html;NA;NA;;


List item
L;github.com;etcd v3.0.14 Release Notes;https://github.com/coreos/etcd/releases/tag/v3.0.14;NA;2016;;;


List item
L;cisco.com;Release Notes for TelePresence System Software Release IX 8;http://www.cisco.com/c/en/us/td/docs/telepresence/ix_sw/8_x/release/notes/ix_release_notes.html#pgfId-121127;NA;NA;;


List item
L;cisco.com;Cisco TelePresence System C/SX/EX/MX/Profile Series Software release notes TC7;https://www.cisco.com/c/dam/en/us/td/docs/telepresence/endpoint/software/tc7/release_notes/tc-software-release-notes-tc7.pdf;NA;NA;;


List item
L;doc.pmod.com;PMOD Technologies Software Release Note - New Features and Enhancements in EECS 2.0.6;http://doc.pmod.com/PDF/ReleaseNotes.pdf;NA;NA;;


List item
L;library.e.abb.com;Software Release Note for ABB Automation Inc. GPUECP V/W 3.08;https://library.e.abb.com/public/f39f45be4e14087385256f3200511272/GPUECPV1.23SwReleaseNote.pdf;NA;NA;;


List item
L;rohde-schwarz.de;T80-K1 V2.22 Release Note - version 2.22 additional features overview;http://www.rohde-schwarz.de/file/T80-K1_V2_22_Release_Note.pdf;NA;NA;;


List item
L;documentation.cpanel.net;cPanel & WHM Product Versions and the Release Process Documentation;https://documentation.cpanel.net/pages/viewpage.action?pageId=2719905;NA;NA;;


List item
L;wiki.duraspace.org;DuraSpace DSpace Release 6.0 - Including Release Status, Documentation and Schedule;https://wiki.duraspace.org/display/DSPACE/DSpace+Release+6.0+Status;NA;2016;;


List item
L;wiki.opendaylight.org;OVSDB Integration: Helium Release Notes;https://wiki.opendaylight.org/view/OVSDB_Integration:Helium_Release_Notes;NA;NA;;


List item
L;github.com;Release Train Hopper - most significant features and bugfixes implemented in the Spring Data Hopper release train;https://github.com/spring-projects/spring-data-commons/wiki/Release-Train-Hopper;NA;2016;;


List item
L;support.aha.io;Aha! Release Notes through 2016-03-11;http://support.aha.io/hc/en-us/articles/208248603;NA;2016;;


List item
L;wiki.ubuntu.com;Ubuntu 16.04 LTS Release Notes;https://wiki.ubuntu.com/XenialXerus/ReleaseNotes;NA;2016;;


List item
L;docs.moodle.org;All official releases of Moodle, grouped by branch in reverse chronological order;https://docs.moodle.org/dev/Releases;NA;2016;;


List item
L;wiki.centos.org;CentOS Documentation and Release Notes;https://wiki.centos.org/Download;NA;2016;;


List item
L;staf.sourceforge.net;Software Testing Automation Framework (STAF) Release Notes;http://staf.sourceforge.net/getcurrent.php;NA;2016;;


List item
L;support.shotgunsoftware.com;Release Notes;https://support.shotgunsoftware.com/forums/55639-Release-Notes;NA;NA;;;



Tools


List wrapper


List item
L;maven.apache.org;Apache Maven Changes Plugin;http://maven.apache.org/plugins/maven-changes-plugin/index.html;NA;NA;;;


List item
L;github.com;GitReleaseNotes;https://github.com/GitTools/GitReleaseNotes;NA;NA;;;


List item
L;psoda.com;Psoda - Capture Release Notes;http://psoda.com/cms/what-is-psoda/product-management/release-notes?v=0;NA;NA;;;


 


Anchor
further_reading
further_reading

Further Reading


Further reading

Children Display
depth2
pageSoftware Release Communication and Training
excerpttrue

Image Removed

excerptTypesimple



Cta item
resourceID001


Cta item
resourceID002