RE: Release Notes

["Chris Vickery" <cvickery -at- arenasolutions -dot- com>]

We have Technical Release Notes that list every upgrade, enhancement,
new feature, and bug fix. Since our release notes are linked permanently
from the dashboard of our application, and we do multiple releases per
year (since we are SaaS), I make sure the Technical Release Notes are
self contained--an exhaustive list. I have a link to the User Manual,
but I don't specifically reference updates per note.

In fact I am just finishing up the marketing version of the release
notes for our Fall '07 release. I end up having to write the engineering
version and then translating it into marketing. I wonder if Babelfish
can do that?

Chris

-----Original Message-----
From: techwr-l-bounces+cvickery=arenasolutions -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+cvickery=arenasolutions -dot- com -at- lists -dot- techwr-l -dot- com]
On Behalf Of Zen C
Sent: Wednesday, August 22, 2007 1:05 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Release Notes

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.

Thanks,

Zen
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.DocToHelp.com/TechwrlList

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

---
You are currently subscribed to TECHWR-L as cvickery -at- arenasolutions -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit
http://lists.techwr-l.com/mailman/options/techwr-l/cvickery%40arenasolut
ions.com


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
http://www.techwr-l.com/ for more resources and info.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.DocToHelp.com/TechwrlList

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

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.