Re: This too is technical communication

Subject: Re: This too is technical communication
From: "Raj Machhan" <raj -dot- machhan -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 5 Jun 2007 09:46:33 +0530

I agree with Stuart's views. Technical writing does not have any place for
idiots of any kind, including the professional ones. A good technical writer
should be sharp enough to quickly grasp the functionalities of an
application. Making the complex simple is no idiot's job. Moreover, it
requires high level of intelligence to understand the needs of the target
audience.


Raj

On 6/5/07, Stuart Burnfield <slb -at- westnet -dot- com -dot- au> wrote:
>
> Mike Starr said:
> > I've often opined that one of my principal duties as a
> > technical writer is to be a "professional clueless idiot".
>
> I think this is a dangerous and unnecessary strategy.
>
> If you're pretending to be a clueless idiot, it's hard to avoid
> overwriting and overexplaining. You'll be tailoring the docs to make
> them more usable by a handful of users, at the expense of the
> overwhelming majority of users. (I'm assuming you haven't identified
> clueless idiots as a significant segment of your target audience :^)
>
> As a computer user, when I need to look up the documentation I don't
> think to myself that it's because I'm a clueless idiot. I think it's
> because there's some information I need that I don't have, or because I
> need a refresher on something I used to know. For example:
> - I did a few manuals in Word 2000 but now I need to set up a template
> in Word 2007 for the first time
> - I'm a very experienced user of Frame but I've never needed to produce
> Help output or create equations till now
> - I know I can wrap text around the outline of a graphic but I don't
> remember what it's called or how to do it
>
> I don't think any of these situations makes me a clueless idiot. If
> there's the faintest patronising whiff in the writing that the author
> thinks I am a clueless idiot (such as elaborate, baby-talk detail) I'd
> be a pretty unhappy customer.
>
> As Alan Cooper said, imagine the user as intelligent but very busy.
>
> Stuart
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 raj -dot- machhan -at- gmail -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/raj.machhan%40gmail.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.
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.


Follow-Ups:

References:
Re: This too is technical communication: From: Stuart Burnfield

Previous by Author: Re: Most illogical documentation
Next by Author: Re: "to persist data"
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