TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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 read.me files.
____________________________________________________
Joanne Grey Senior Technical Writer
j -dot- grey -at- worldnet -dot- att -dot- net #include <disclaimers.h>
joann -at- genesyslab -dot- com http://www.genesyslab.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
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