What makes a good Tech Writer

Subject: What makes a good Tech Writer
From: "Peter Ring, PRC" <prc -at- PIP -dot- DKNET -dot- DK>
Date: Mon, 2 Sep 1996 09:34:06 +1

On Friday 30 Aug 1996 Michael Wing wrote:

> Why do you feel (or at least express it this way) that the skills
> are mutually exclusive of each other? Here's my matrix (the Wing
> Technical Writer matrix; simplified to contain only an X and a Y
> axis) for a good Technical Writer (view in monospace font).


> English (Good)|.....................(Excellent Tech Writer)
> Skills | .
> | .
> ^ | .
> | | .
> | | .
> | | .
> | | .
> v | .
> |(Poor Tech Writer) .
> (Poor)|__________________________________
> (Poor) (Good)
> <------------>
> Technical Knowledge/Skills

Thanks Michael for good inspiration!

Of cause, there is something in it, but it is also a dangerous
misunderstanding that this is the whole truth.

First of all - a minor point: in fact, there ARE other languages in
the World than English! A lot of technical documentation is
originally written in and translated to/from German, Japanese,
French, Italian, Danish, Korean, etc., etc., etc., ...

This means that the "English skills" axis should rather be "Language
skills".

But a lot worse: there is one more axis, which is probably the most
important one, and at least more important than the "Technical ..."
axis. In fact, _too much_ technical knowledge to the subject is often
a disadvantage, because then you can't see the users problems. Please
note before flaming, that I don't hate technicians, I _am_ one
(M.Sc. in electronic engineering), and I don't hate myself.

The third axis is "Pedagogy".

***************************************************************
* *
* Bad pedagogy is what makes millions of technically 100% *
* correct manuals with flawless English absolutely useless! *
* *
***************************************************************

So the map should rather look like this (view in monospace font):

(Excellent Tech Writer)
. . . . . . . . . . . . x . . . . .
.. ..
. . . .
. . . .
. . . .
Pedagogy . . . .
Skills . . . .
(Good)| . . . . . . . . . . . . . . . . . .
| . . .
| . . .
| . . .
| /Language skills. . . . . ... . . .
| /(good) . .
| / . .
| / . .
| / . .
| / (Poor Tech Writer) . .
(Poor)|/_________________________________.
(Poor) (Good)
Technical Knowledge/Skills

That's why I fight for pedagogy in technical writing on my "Website
for user friendly manuals" and in my book.

Greetings from Denmark

Peter Ring
PRC (Peter Ring Consultants)
- specialists in user friendly manuals and audits on manuals.
prc -at- pip -dot- dknet -dot- dk
http://www.pip.dknet.dk/~pip323/index.htm
- the "User Friendly Manuals" website with links, bibliography,
list of prof. associations, and tips for technical writers.

TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-



Previous by Author: Intl. list of professional techwriter associations
Next by Author: Audience Analysis
Previous by Thread: Portfolios--a summary
Next by Thread: Re: What makes a good Tech Writer


What this post helpful? Share it with friends and colleagues:


Sponsored Ads