Building release notes in agile development

Many Development Teams are working with scrum creating at least one new software version every three weeks . This workflow including a new version of documentation every three week.

Did we ask us if we should change how do we generate release notes ?

The number of released software versions is increasing using this type of agile methodologies but Don’t you think it’s time to change this?

 

We’re still working in the same way creating documentation and the number of released software versions is increasing using this type of agile methodologies .

 

Me as Developer when I have to work in any support tickets from an old version it’s hardest find which one was the released version for some feature or look for another type of documentation.

I believe a good options will be an html/markdown release note auto-generate is the best option.

Did you ever had the same scenario ?

I can’t imagine how easy will be for customers find in which version was a feature or bug to know in which release notes or other documents it’s appearing and it will be worst if we have word document for release notes.

The worst hardest option will be a release note generated via a word document because if we need to find in which released version had some feature this task it will be a pain and it’ll take time to us.

Don’t you think it’s time to change this? In the examples bellow we case see how was managed the documentation specially the release notes by big companies Microsoft or Firefox:

Office 365 channel release bit.ly/officechannelreleases
I think this type of application give to the customer a really good tool to spent less time find for release notes and other documents.

microsoft_releasenotes_portal

Firefox has an interesting way to show global view to show all the versions http://bit.ly/firefoxreleasenotes

firefox_releasenotes

Firefox has a good user experience to show the content of the release notes http://bit.ly/firefoxreleasnotesux

firefox_releasenotes3

JIRA provides the functionality to create release notes for a specific version of a project. The release notes contain all issues within the specified project that are marked with a specific “Fix For” version. The release notes can also be generated in a number of formats (e.g. HTML, plain text, etc.) so as they can be included in various documents

image2015-9-2410-15-49

Do you think this could be an interesting approach? which one do you use?
Please feel free to share you thoughts here on in this twitter’s thread 😉

 

Tweet related with this article:

Leave a Reply

Your email address will not be published. Required fields are marked *