Detailed change logs should be made available before the user updates
Ask any developer what their biggest pet-peeve about developing software is and they will all most likely tell you its documentation. And although the daunting task of proper documentation is needed, I’ve recently been more concerned with detailed change logs being made available before the user updates their applications.
The reason
The main reason to make your change logs available prior to distributing the update is simply to allow the user(s) to make a choice whether or not to upgrade to the latest version. There are times when an update to an application comes along, and it actually removes certain functionality or adds undesired features or UI changes. In these instances I would personally like to be able to make the choice to upgrade or not, based on detailed change logs - rather than guess-work. And in this time of the Internet where everything is readily available almost immediately upon publish, its essential to make those changes known prior to the update being distributed.
Bad example
If you would like to see what you should not do watch Apple. When a new version of one of their applications is released, their Website does not usually have a fully detailed change log until after the update has been distributed. There are times when I’ve seen them post minimal details and then later on update the document with a more detailed change log.
I’m not aware of there being any real reasons behind this, other than the possibility that Apple doesn’t nail down the exact features they will make available in an update until just prior to release.
Great example
TextMate notifies you, even while using TextMate, that an update is available. Not only that, but it gives you the choice to upgrade or view the change log right in the alert prompt. TextMate actually goes one step beyond the norm, and will distribute its updates with a change log via an appcast. Appcasts are essentially XML feeds, with enclosures containing the latest build of the app, which contents fully describe the update that is available. This makes upgrades and degrading quick and easy.
More information on appcasting can be found on Fraser Speirs Website, whom I believe was the person that “created” appcasting.
Related sites
Recent features
The Format - Give It Up
Leah Andreone - Break Your Fall
Coheed and Cambria - The Velorium Camper II: Backend Of Forever
Song of the week
Sara Bareilles - Between the Lines
Sara Bareilles' "Between the Lines" is the Song of the Week for April 20 to 26.