RE: Re: Great piece on marketing collateral

Subject: RE: Re: Great piece on marketing collateral
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: 30 Apr 2004 19:14:24 GMT


Unfortunately, there is still a hell of a lot of
technical writing going on that is "function based,"
rather than "task based." This seems to be especially
common in the software world. In hardware, where
I've spent most of my working life, if you wrote
instructions for a transmission or a jet engine that
identified what every component did but not how to
install, adjust, operate and maintain it you'd be
sent packing, but there's an enormous amount of SW
documentation that tells you what every button and
field does but not how to get anything done with them.

I rencently attended a local publication manager's
forum where (surprise, surprise) the discussion of
the day was offshoring. One attendee opined that
tech writing overseas was still behind writing in
the US because "their" writers were still doing
function-based writing and hadn't learned to base
user docs on tasks, "the way we've learned to in
the US." My first thought on hearing that was,
"I must not have been on distribution for the email
announcement on that one."

Gene Kim-Eng


------- Original Message -------
On Fri, 30 Apr 2004 11:10:22 -0700 (PDT) David Neeley wrote:

Of course, few tech docs today seem to be well indexed--so finding pertinent help is a great challenge in many manuals. Online help can be just as bad...my own frustration with most of it has been to spend considerable time in finding the topic, only to discover that the online help system confidently *says* the program will do what I've been searching for, but rarely gives actual instructions on *how* to do it.

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

ROBOHELP X5 - ALL NEW VERSION. Now with Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more!

Now is the best time to buy - special end of month promos, including:
$100 mail-in rebate; Free online orientation on content management
functionality; Huge savings on support and future product releases;
PLUS Great discounts on RoboHelp training. OFFER EXPIRES April 30th!
Call 1-800-358-9370 or visit: http://www.ehelp.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.



Previous by Author: RE: monster.com and the like
Next by Author: Best practices for distributing custom templates?
Previous by Thread: RE: Great piece on marketing collateral
Next by Thread: RE: Re: Great piece on marketing collateral


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


Sponsored Ads