Re: Release Notes

Subject: Re: Release Notes
From: Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 23 Aug 2007 10:19:49 +0800

As much as possible, the main docs should be complete, correct and
current with respect to the latest version of the product. It shouldn't
really contain much history on how things worked in older releases.
Given this, the main job of the release notes is to brief users on what
has changed or been learned recently (bugs, fixes, workarounds) and
hasn't yet been added to the full docs.

The more detailed operational information you put in the release notes,
the more often a user will be forced to look in two places to look for
an answer. As a software user, I hate that--don't you?

Zen C said:
> hehe good question about what customers want. I don't think they
> even read it..they are a lazy bunch.

A bit of free advice... be really careful with that attitude. Maybe your
customers are somehow statistically lazier than the general population,
but I can't think why that would be. It's also possible that your
customers avoid reading your docs because they've them unhelpful in the

I have no way of knowing which of these is true, but I do know this: you
can't make your customers less lazy, but you can make your docs better.
Work on the thing that you have some control over. Imagine that your
users are hard-working but *busy*. Help them be successful by not
wasting their time.



Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: Free download of StarOffice from Google
Next by Author: Word 2000: Page Br disturbs my headings in doc map
Previous by Thread: Re: Release Notes
Next by Thread: Re: Great Technical Manuals from Canon! (Was - Re: Tech writers stillnecessary, but performing poorly)

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

Sponsored Ads