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: Do I have to understand the material? From:"Christensen, Kent" <lkchris -at- sandia -dot- gov> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 19 Aug 2002 10:59:48 -0600
Coming late to this thread ...
IMHO the closest to "getting it" comment was from "Doc" suggesting "keeping
the users in mind."
Indeed.
I'd offer that "understand the material" is a phrase that's just too vague
... what the tech writer should "understand" is what the *user* understands
when he or she uses the product and its manual to perform his or her job.
Said another way, the tech writer ought to know how to *be* a user.
Ok, maybe the tech writer won't be a welder, and another poster indicated
instead "welders are involved in the final review of the manual." Good.
But, that's pretty vague, too. More to the point, if the tech writer is
indeed a good user, he or she is still a sample of one.
The point, then, is manuals should be tested. By users. And, for heaven's
sake, don't think the subject matter expert is a user--he or she knows too
much and isn't objective.
The answer to the question "do I have to understand the material" is another
question: Do I have a meaningful test plan for my manual? Ideally testing
by (some) users occurs prior to final publication. Also falling under the
heading "meaningful" is intelligent selection of the sample of users. And
using valid prototypes or actual final production samples. Etc.
Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
