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:Version Release Notes From:Rebecca Phillips <Rebecca -at- QRONUS -dot- CO -dot- IL> Date:Thu, 23 Jan 1997 16:29:23 +0200
Part 2: I am hesitant about suggestions from new manager has made for
the documentation, and I would like to bounce them off of you guys.
Release notes, by nature, include features which are relevant to various
different parts of the manual. Under each feature description in the
release notes, she would like me to write the name and number of the
affected chapter under each feature.
I think that in most cases, the user will derive no benefit from
referring to the manual. For example, if the dialog box has changed,
what good does it do for him to look back at the manual and compare the
existing to the new? On the other hand, there is good logic in placing
new features within the context of the user manual.
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?
Rebecca M. Phillips
Qronus Interactive Ltd.
Automated System Testing http://www.qronus-int.com
rebecca -at- qronus -dot- co -dot- il