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: Assumption of Knowledge From:Glen Accardo <glen -at- SOFTINT -dot- COM> Date:Thu, 9 Feb 1995 17:30:51 -0600
> Those of us who write user manuals know that, in many cases, NOT
> understanding what you're documenting initially is a PLUS--you are all that
> much more careful about writing down what users need to know, and may run into
> the same problems users run into.
So if Ralph Ellison were white, he would have done a better job of
writing Invisible Man? Without a depth of understanding, you can't
be certain of anything you say -- you are only guessing. Guesses make
crappy manuals.
I've written users manuals, and seen similar manuals written by people
you imply are better suited to do it. When people didn't understand
the product, they wrote crappy documentation. Period. When people
who understand the product write the manual, at least there is hope.
The ideal candidate is someone who understands the product and how
to document it. Remember, just because someone else understands the
product doesn't mean that what you write is good.
------------
glen accardo glen -at- softint -dot- com
Software Interfaces, Inc. (713) 492-0707 x122
Houston, TX 77084
