Re: Concepts (was Technical Writing Tests)

Subject: Re: Concepts (was Technical Writing Tests)
From: Jan Henning <henning -at- r-l -dot- de>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 14 Feb 2003 16:20:44 +0100


Furthermore, I firmly believe users want (and need) to know WHY they are doing
things. When you accurately document the "why" and "what", the "how becomes
almost incidental. If you understand why things work they way they do, then how
to make them do that is relatively straight forward.

I think it is of little value to make generalizations about users or writers (or indeed about many other things).

Many users in many situations benefit from conceptual knowledge because it makes it much easier to understand concrete steps they have to perform.

But this is not always true. For example, I doubt that a burger flipper needs much in the way of underlying concepts for his or her work - the procedural steps of how to assemble the ingredients into a meal (using the term loosely :-) is all they need.

So, once again, it comes down to knowing your audience and giving them what they need. Frequently, that will mean at least some conceptual framework, but not always.

Regards
Jan Henning

--------------------------------------------------------------------
Jan Henning
ROSEMANN & LAURIDSEN GMBH
Am Schlossberg 14, D-82547 Eurasburg, Germany

Phone: +49 700 0200 0700, Fax: +49 8179 9307-12
E-Mail: henning -at- r-l -dot- de, Web: www.r-l.de
--------------------------------------------------------------------


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

Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
Order online today at http://www.ehelp.com/techwr-l


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



References:
Concepts (was Technical Writing Tests): From: Andrew Plato

Previous by Author: Re: Updateability - word needed
Next by Author: Re: Concepts (was Technical Writing Tests)
Previous by Thread: Concepts (was Technical Writing Tests)
Next by Thread: Re: Concepts (was Technical Writing Tests)


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

Sponsored Ads


Sponsored Ads