Re: Have We Entered a Post-Literate Technological Age?

Subject: Re: Have We Entered a Post-Literate Technological Age?
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 21 Aug 2009 09:04:13 -0700

User/application/environment-dependent. I haven't written a "click OK"
procedure for a user-guide-type product document since the 90's. The
typical user instructions for most of the products I've documented will
say something like "The <insert screen title> screen enters the
configuration parameters for <insert name of operation here>," because
our intended users do not need to have any of the parameters explained
to them and would probably be insulted if we tried. The only product
documents we write with that detailed, click-by-click structure are
certain procedural instructions and checklists that are mandated to be
written and used that way (it will never be time to kill task-oriented
docs for pilots, aircraft mechanics, weapons handlers, powerplant
operators, etc.)

OTOH, when I jot off internal office instructions on how to set up
things like Word templates or VPN connections, our own people, including
software engineers, always seem to need that level of handholding. Go
figure.

Gene Kim-Eng



----- Original Message -----
From: "Chris Despopoulos" <despopoulos_chriss -at- yahoo -dot- com>
> But the ubiquity of the technology leads to something I really want to
> discuss... Is it finally time to kill task-oriented docs and get down
> to explaining what the various GUI fields actually *mean*?

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

Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.
http://www.doctohelp.com/SuperPages/Webcasts/

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! 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.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
RE: Have We Entered a Post-Literate Technological Age?: From: Chris Despopoulos

Previous by Author: Re: Have We Entered a Post-Literate Technological Age?
Next by Author: Re: "No RGBA loader" after TIF scan
Previous by Thread: RE: Have We Entered a Post-Literate Technological Age?
Next by Thread: Re: Have We Entered a Post-Literate Technological Age?


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

Sponsored Ads


Sponsored Ads