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:Getting more than nits from reviews From:Stuart Burnfield <slb -at- westnet -dot- com -dot- au> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 23 May 2007 18:07:58 +0800
On the cover page or e-mail, state your expectations in clear language
and big letters:
"Thanks for taking part in this technical review. It is intended to
catch any technical problems in <name of pub>. I would like you, as a
technical expert, to highlight any technical material that appears
wrong, incomplete, misleading or confusing. You can either add your
detailed comments to the draft, or simply flag the problem and I'll
follow up with you in person.
As this is an early draft you may find problems such as typos and
punctuation errors. Don't worry about looking for these now. There will
be a separate round of copyediting reviews later. (Let me know if you'd
like to be included in that group of reviewers also)."
________________________________________________________________________
For the real recalcitrants, reinforce the message in person (if you hand
over a paper copy) or by phone (if you e-mailed the draft). "Thanks for
doing this... Don't worry about typos... I have other reviewers who can
concentrate on those later... You're the only person who can review the
technical content so I need you to focus on that..."
Good luck
Stuart
Susan Hogarth said:
> I recently sent a rough draft around to a bunch of SMEs looking for
> substantive input, and they wasted their precious (and expensive)
> time copyediting it, while making no substantive contributions.
> I didn't know whether to be more humiliated or aggravated.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-