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:Eric Haddock <eric -at- ENGAGENET -dot- COM> Date:Thu, 24 Oct 1996 10:52:56 -0500
>a) doing nothing.
No, you know in your heart this isn't the right thing to do.
>b) inserting a loose page
I personally hate loose sheets of errata because I have to constantly
keep track of them because there usually isn't any folder or binder or
something with the manual that I could put the errata in. Even so, such a
pocket would have to be in the cover of the manual for me to remember it all
the time--and I'd have to be sure to mention the errata to anyone I gave the
c) adding a little blurb in the readme file. No one reads these
I always read them--but I never print them.
You could, if you have enough money and if the logistics of the error are
such, print up a bunch of stickers with the correct text. Issue them with
the manual and instruct the user to apply the sticker over the incorrect
portion of the text.
This, if you have the money, is the optimal situation, I think. The user
does this once and can forget about it--and can hand the manual to anyone
without any special "see the errata" instructions or anything.
Alas, this only works for tiny errors. :/