Re: Question about release notes

[Alexia Prendergast <alexiap -at- SEAGATESOFTWARE -dot- COM>]

I've seen it done both ways -- "long and verbose" and "short and sweet".
Here's my preference, which meets the needs for accessible and
complete information.

The release notes describe:
-New features
-Fixes
-Enhancements
-Known problems
Each category consists of concise descriptions in table or list form.
(Some companies have different, obscure euphemisms for these terms
depending on how much they actually think they can get over on their
customers.)

In addition to the release notes, the customers might get the
following documents:
-Installation Notes (if the procedure has changed)
-Documentation Addenda (if there is a bunch more functionality,
 new screens, procedures, etc.)

I *don't* lump the information together in one doc because each
doc has a different purpose, audience, and life span.
--
Alexia Prendergast
Senior Technical Writer
Seagate Software
alexiap -at- sems -dot- com

>----------
>From:  Julie F. Hesselgesser[SMTP:jhesselgesser -at- OXMOL -dot- COM]
>Sent:  Tuesday, July 08, 1997 1:05 PM
>To:    TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>Subject:       Question about release notes
>
>Are there any standards or rules about what constitutes release notes?

 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