RE: This too is technical communication

Subject: RE: This too is technical communication
From: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 5 Jun 2007 16:12:11 -0600

This sentiment has been expressed about five different ways on this
thread, and I just don't get it:

> Even when we do know all of the shortcuts and can dive into
> an application and go to work, we still need to document the
> application according to the path that the user will take.
> So we get information that we personally do not need.

If I personally _don't need_ the information, it's because I _already
have it_.

If I'm a good technical writer (which, as someone pointed out, has _a
lot_ to do with analytical thinking), and I know something about my
audience, and I thoroughly know the application I'm documenting, then I
can produce the appropriate documentation with the appropriate level of
complexity, detail, etc.

I don't need to empty my head of pre-existing application knowledge and
re-learn it from a starting point of ignorance -- even if I could, it
would be wasteful and silly.

In the immortal words of Andrew Plato, "Ignorance is not a valuable
commodity regardless of how you spin it."

Richard


------
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


References:
RE: This too is technical communication: From: Lauren

Previous by Author: RE: This too is technical communication
Next by Author: RE: Visuals in work instructions: how many is too much?
Previous by Thread: RE: This too is technical communication
Next by Thread: RE: This too is technical communication


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


Sponsored Ads