Re: Release Note Formats

Subject: Re: Release Note Formats
From: John Bartol <johnbartol -at- shaw -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 21 Apr 2005 09:12:55 -0700

Take what I say with a "I've only done about 10 of these"-sized grain of salt.

Like so much else, it depends :-)

I've used 3 formats depending on the content of the release, user knowledge, and existing versions.

Item > Resolution: I've used this on releases that primarily addressed specific 'items' (call 'em bugs, problems, etc.) and were being distributed to a user base that was all running the same version of the system.

Changes to system: I've used a chapter based format (1 chapter per system section) in which I describe 'perceived' changes to the system where the notes were being distributed to a user base on multiple versions of the system (in other words, an upgrade release to version 5 from versions 3.2, 3.3, 4.*). For many of the earlier releases, no notes were distributed (or poor notes were distributed).

Combination of above: I've single-sourced release notes to generate custom combinations of the above formats based on subsets of the customer base.

Overall, I'd say the split is about even between all three formats.


Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Release Note Formats: From: The Peanut Gallery

Previous by Author: RE: Just can't help myself
Next by Author: Re: Portfolios (and another question)
Previous by Thread: Re: Release Note Formats
Next by Thread: Re: Release Note Formats

What this post helpful? Share it with friends and colleagues:

Sponsored Ads