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.
1. There is an interesting bias towards software/hardware documentation
here. This question assumes a product that has an interface and a
user-level curve (novice, standard, power???). Likewise, it assumes the
product exists in an industry that you could claim has a body of knowledge
that is attainable. This question leaves out a large segment of writers:
insurance, banking, cookbook, etc.
2. I wrote the documentation for the first MPEG1 encoder (Philips only made
11 at a customer cost of $150K each). There was no MPEG industry yet and we
were building the knowledge block that later writers might use. The product
interface was a direct input to varying the 40+ variables in the encoding
equations. The originator of the equations (Dr. OJ Morris in London) didn't
even know what the effect of changing some variable would be. No power
users and no experts on the GUI.
Granted, this is a cutting edge issue, but I think it plays hash with the
question. Tech writers must be able to grasp each of the proposed options
as they become available. But that doesn't mean they have to start with
them. One of the prime requirements of a tech writer in my mind is the
ability to grasp and integrate new information. If you can't do that, then
your pretty much trapped in what you know coming into a situation.
As far as the three options below, every writer should be able to attain 1
through 4. I only hire writers that can attain option 6, because they are
the writers that can live on the cutting edge.
> What is the minimum level of product knowledge
> a tech writer needs to write end-user documentation?
>
> * Basic knowledge of functionality and interface
> * Option 1 (above) plus industry knowledge
> * Advanced knowledge of the product (power user)
> * Option 3 (above) plus industry knowledge
> * Engineer-level knowledge of the product
> * Option 5 (above) plus industry knowledge
> * Other/none of the above
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by an
anonymous satisfied subscriber since 1994.
---
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.
