Re: Version Release Notes

Subject: Re: Version Release Notes
From: joanne grey <j -dot- grey -at- WORLDNET -dot- ATT -dot- NET>
Date: Thu, 23 Jan 1997 18:27:11 -0800

Nostradamus predicted that Rebecca Phillips would write:

> For those of you who write version release notes, do you refer back to
> the parts of the manual affected in the release notes themselves? Do
> customers find this helpful? Distracting? Do you think it's a good idea?

We never refer to chapters or pages in the original document in a
release note. Enhancements are discussed at whatever length is
neccessary, but we don't send the user back to the manual. We *do*
refer to them in Publication Notes - where we can state that the
information on page xx needed clarification, or something along those
lines, and in files.

Joanne Grey Senior Technical Writer
j -dot- grey -at- worldnet -dot- att -dot- net #include <disclaimers.h>
joann -at- genesyslab -dot- com

Courage is the price that love exacts for granting peace.
-Amelia Earhart

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
Search the archives at or search and
browse the archives at

Previous by Author: Documenting unused apps: (Was:Knowing prog. lang. +s to a TW's $?)
Next by Author: Re: How Many Projects Can One Person Handle
Previous by Thread: Version Release Notes
Next by Thread: Re: Version Release Notes

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

Sponsored Ads

Sponsored Ads