Re: Question about release notes

[Carla Lotito <carla -dot- lotito -at- BERCLAIN -dot- COM>]

Although most major software companies do provide release notes in ASCII
format,   I think that you should consider exactly why you would provide
your users with detailed explanations and screen shots. Just because
everyone does it in one format does not mean the "standard" format suits
everyone.

If changes in your software are so subtle yet important or major that your
users will need the information (and screen shots and examples), it may be a
good idea to provide release notes in a document format instead of an ASCII
file.

It all depends on:

* the level of complexity of the changes
* what effect changes have on users
* how much time you have to write the release notes (graphics and screen
shots and layout add more time to the writing cycle)

And, even if you do a document format, you don't need to provide hard copy
documentation. You could go with PDF (and have users print the file
themselves), with HTMl or with winhelp.

No matter what you choose, you'll have to document those new features and
screens sometime. If not now, later.

Carla.

 TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot-  Send commands
   to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
  Search the archives at http://www.documentation.com/  or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html