Release Notes

Subject: Release Notes
From: "Zen C" <zenizenc -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 22 Aug 2007 16:04:43 -0400

Hi All,

It is my first time working on release notes and from all the samples I have
had a chance to look at online, I realized that what it should include is a
brief description of what is changed and you redirect the user to the help
file for more detailed information. Am I right or wrong?

The person reviewing my release notes came up with this suggestion.

Add screen shots for items that have one. For example if printing options
are changed for something, explain the way it is done and add screen shots
as it would be in the help file. I know you point them to the Help system,
which is great, but they are lazy.

Any suggestions on this comment ? Do release notes usually go out with a lot
of details or is a brief outline of what is changed only?

Please send me your comments.



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: See Also/Related Topics
Next by Author: Re: Release Notes
Previous by Thread: Re: Automatic software downloads from an HTML page?
Next by Thread: RE: Release Notes

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

Sponsored Ads