Understanding vs. Instruction

Subject: Understanding vs. Instruction
From: "M. Dannenberg" <midannen -at- SI -dot- BOSCH -dot- DE>
Date: Mon, 30 Jun 1997 10:03:19 +0200

The idea that documentation should tell how the product solves the
user's problems, rather than telling how to do it is throwing out the
baby with the bathwater, in my opinion. Everybody has probably been
annoyed about manuals that explain every stupid menu command of a
program without telling what the whole caboodle is good for, or how to
go about doing anything with it. Falling into the other extreme is
usually not a good idea, though.

A good manual has to do both, inform and instruct. Ideally the two can
be integrated, the instructions should be organised along the ways users
use the product and all that. For very complex products it may ne
necessary to include a separate theory part, but that approach is
probably not advisable for consumer products.

Mike

--
Mike Dannenberg
ETAS GmbH & Co.KG
midannen -at- si -dot- bosch -dot- de

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Re. Startiegies for Improving the Place of Tech Comm
Next by Author: Re: EMBEDDING URLS IN E-MAIL?
Previous by Thread: Re: still looking for a book
Next by Thread: Re: Understanding vs. Instruction


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


Sponsored Ads