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: Errata for procedures From:Kelly Schab <schabk -at- CYBERENET -dot- NET> Date:Thu, 10 Jun 1999 21:25:04 -0400
On Thu, 10 Jun 1999, Rowena Hart wrote:
> I just found out that one set of procedures for Unix users
> is incomplete. The print document is being trimmed
> as I type. The deadline for changes to the PDF was two
> days ago. That means we have to produce an "errata"
> notice.
>
> In that errata notice, would you:
>
> (a) Reprint the installation instructions for that section
> (about one page of information), including the new steps,
> thereby allowing the user to simply "replace" the old
> section with the new one.
>
> or
>
> (b) Identify the section and say something like "The
> installation instructions in this section are incomplete.
> After you have completed steps 1 to 4, you must..."
Slipsheet! ;)
I would choose (a) because it would allow the user to go through the steps
from start to finish without having to refer back and forth between the
manual and the errata sheet. It might make things less frustrating.
