RE: Tech writers still necessary, but performing poorly

Subject: RE: Tech writers still necessary, but performing poorly
From: Chris Borokowski <athloi -at- yahoo -dot- com>
To: Jessica Weissman <Jessica -dot- Weissman -at- hillcrestlabs -dot- com>, techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 30 Jul 2007 13:34:17 -0700 (PDT)

You've hit on something important there. Sometimes the best
documentation is a numbered set of steps, written simply or in images,
that can get people on track (mostly) without lengthy or confusing
manuals.

The "Ikea method" of technical writing is underrated in some cases, but
not all. If a new C++ compiler shows up with a pictorial guide, I'm
going to clobber someone. However, even within traditional
documentation, it can be useful to cut the words and go with the
simplest possible route to the truth.

--- Jessica Weissman <Jessica -dot- Weissman -at- hillcrestlabs -dot- com> wrote:

> I'm not sure that any booklet would have helped these people, short
> of a
> set of stickers on the machine itself (or, just maybe, a pictorial
> foldout) telling them exactly what to do in what order.


http://technical-writing.dionysius.com/
technical writing | consulting | development


____________________________________________________________________________________
Luggage? GPS? Comic books?
Check out fitting gifts for grads at Yahoo! Search
http://search.yahoo.com/search?fr=oni_on_mail&p=graduation+gifts&cs=bz
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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: Tech writers still necessary, but performing poorly: From: Jessica Weissman

Previous by Author: Re: Firefox vs IE - help
Next by Author: Re: Tech writers still necessary, but performing poorly
Previous by Thread: RE: Tech writers still necessary, but performing poorly
Next by Thread: Ikea method of technical writing (graphical instructions)


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


Sponsored Ads