Clarification

Subject: Clarification
From: Moshe Koenig <alsacien -at- NETVISION -dot- NET -dot- IL>
Date: Sat, 10 Aug 1996 10:08:38 PDT

In response to Robert Plamondon's remark that my definition of technical
writing is "strange": what I meant to say was that in good technical
writing, the writer's ego takes a back seat to conveying the information
in a clear fashion to the reader. It's not that "highly mannered"
documentation doesn't exist; it's just that the mannerisms are definitely
NOT the essence, only ornaments.

Currently I am documenting a product that is about to be released, and
there is no question that it is as "highly mannered" as you're going to
find, but there is a reason: the product calls itself "the database for
dummies". The manager of the company WANTED a rather whimsical manual
to create an attitude that the user did not have to be the nerdy kid
next door named Edgar who learned to count in hexadecimal base and
speaks only C++; the idea was to be informal, but that was because
the product is very intuitive and has to live down the reputation that
end-user database tools have acquired. There are justifications for
making documentation more individualistic, but that's not the ultimate
goal; it's a by-product of a more complex process.

- Moshe

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: Technical Writing: a Calling?!?
Next by Author: I Started It, So I Finish It
Previous by Thread: Re: Do windows appear?
Next by Thread: Pencil Test for Technical Writers


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

Sponsored Ads


Sponsored Ads