Errata coverage

Subject: Errata coverage
From: Mac McCartt <mmccartt -at- AUTOIII -dot- COM>
Date: Wed, 8 Oct 1997 08:24:24 -0700

I find myself in a position where what I want to do is opposed by nearly
everybody else who has expressed an opinion. Maybe the writers on this list
can share their opinions on this subject with me as well.

The point of contention is about how to cover idiosyncrasies of the
software product for which I write manuals.

My view is that I should document these non-critical "errors" in the heart
of the manual (a sample error is one in which a dialog box is displayed
improperly, not showing all of the two buttons that reside at the bottom of
the dialog box). My contention is that, unless covered in the manual, the
idiosyncrasies are in danger of becoming "hidden" -- and therefore
potentially confusing for the user.

The opposing view is that coverage of this kind of error belongs in the
release notes, not in the manual. Covering this error in the manual (the
opposition goes on to say), "enshrines" it -- and needlessly complicates my
(the writer's) life. It would seem that this view presupposes that release
notes are read religiously (or more religiously than the manual, at any
rate).

What do you think?

- - - Electronic Signature - - -
Mac McCartt/mmccartt -at- autoiii -dot- com/805 376 5223/FAX 805 376 5005
- - - Electronic Signature - - -

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Becoming a Technical Writer
Next by Author: Need help with Word 97 macros
Previous by Thread: Strategic Plan Document Format
Next by Thread: Re: Errata coverage


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads