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:Finding errors in manuals? (take II) From:Geoff Hart <ghart -at- videotron -dot- ca> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>, Dori Green <dgreen -at- associatedbrands -dot- com> Date:Fri, 18 May 2007 09:19:45 -0400
Dori Green notes: <<Here's the trick I learned in college: always
include a few harmless errors so the professor doesn't dig deeper to
discover that the entire foundation of the logic in your reasoning is
fatally flawed.>>
It's rare when you're working without an editor or peer reviewer that
it becomes necessary to consciously add errors; there are usually
plenty of them without such intent. Simply part of the nature of the
game of writing... and I say this as someone with more than 300
published articles in print.
You'll often see this trick recommended as a way of ensuring that
reviewers are actually paying attention, but in general, it's a bad
idea. (Sorry to be so blunt!) The problem is that most of us are way
too busy at work, and particularly under deadline pressure and when
you're operating on 4 hours' sleep, removing the inserted errors
becomes yet another detail that's easy to miss. Thus, in the editing
community, there are countless anecdotes about errors that made it
into print (nowadays, onto the customer's hard disk) as a result.
That's not to say that you should never do this; it can be a useful
way to convince a manager that the SMEs are not performing adequate
reviews, and that the company may find itself in serious legal
jeopardy as a result. But if you do this, you must ensure that
removing the errors is a major priority, not just "yet another detail".
----------------------------------------------------
-- Geoff Hart
ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
www.geoff-hart.com
--------------------------------------------------
Coming soon: _Effective onscreen editing_ (http://www.geoff-hart.com/
home/onscreen-book.htm)
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-