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: Summary of changes in prefaces From:"Less is more." <yvonne -at- SATURN -dot- SMARTSTAR -dot- COM> Date:Thu, 13 Jan 1994 08:33:16 -0800
David McMurrey asks:
>What do you all think about including a section in prefaces to
>software and hardware manuals that lists the changes made to those
>books since the previous release/edition?
In the release notes that go out with a new version, we list the new and
revised sections in the manual that users of previous versions should read
to update their knowledge.
Listing structural and wording changes would not provide any added benefit
for the users. In fact, it would clutter up the list of new sections, and
make readers less likely to tackle a seemingly large reading task.
Listing ways I think I've improved a manual seems like bragging. I find
it more useful to send such lists to my boss, than to try to get customers
to read them.
