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: How to treat doc errata? From:"Karl A. Hakkarainen" <karlh -at- AUGGIE -dot- AUGMENT-SYSTEMS -dot- COM> Date:Thu, 24 Oct 1996 11:55:47 -0400
Karl A. Hakkarainen (508) 392-8626
Technical Documentation Manager
Augment Systems, Inc. Westford MA 01886 http://www.augment-systems.com
We've typically used the release notes for this kind of problem. "On page
3-11 of the Fubarb Reference Manual, the statement 'You can operate this
system while in a swimming pool.' is incorrect; ..."
----------
> From: Jane Bergen <janeb -at- answersoft -dot- com>
> To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject: How to treat doc errata?
> Date: Thursday, October 24, 1996 12:32 AM
> The inevitable has happened.... a document we sent to the printer
> needs a change on one page, thanks to a last-minute switch by
> engineering (grrr).
> We will fix the error for future printing, but for **the copies we just
> got back from the printer yesterday** (said through clenched teeth),
> what is the best approach? I am considering:
> a) doing nothing. It's fairly minor and most users could figure it
> out. But on the other hand, they might think we have not figured it
> out yet either.
> b) inserting a loose page calling attention to the error and giving
> the correct information. These manuals are wire bound and we can't
> fix them.
> c) adding a little blurb in the readme file. No one reads these
> anyway......do they?
> I hope this is on-topic....fingers crossed, eyes closed....I've never
> seen it discussed before, but it does affect most technical writers.
> Thanks.
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Jane Bergen, Technical Writer
> janeb -at- answersoft -dot- com
> AnswerSoft, Inc.
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
