TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Stupendously learned user From:Yves JEAUROND <jingting -at- rogers -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 6 Jun 2007 09:24:24 -0400 (EDT)
Stuart Burnfield wrote
"they can't picture what it would be like not to have it."
Excellent. There's a fancy word for that: an epistemological obstacle*,
invented by Gaston Bachelard, a French philosopher. :-)
Consider when Newbies and some not-so-newbies come to a manual
with opinions already set about a product, say based on their experience
with different products (an indoctrination? :-), switching from their opinions
to correct ideas about the product can be an obstacle.
A contextual intro can help destroy or redress incorrect knowledge
about what you are about to explain and knock out an epistemological obstacle.
Stuart Burnfield adds
"The contextual intro helps not just the person who needs to read the
following material, but also people who *don't* need to read it."
How true. A busy reader can see from a good intro whether he
needs the info that is coming or not.
* "J'ai souvent été frappé du fait que les professeurs de sciences, plus encore que les autres si c'est possible, ne comprennent pas qu'on ne comprenne pas. [...] Ils n'ont pas réfléchi au fait que l'adolescent arrive dans la classe de physique avec des connaissances empiriques déjà constituées : il s'agit alors, non pas d'acquérir une culture expérimentale, mais bien de changer de culture expérimentale, de renverser les obstacles déjà amoncelés par la vie quotidienne."
[book cover] http://www.vrin.fr/html/main.htm?action=loadbook&isbn=2711611507
[online source] http://pst.chez-alice.fr/svtiufm/obstaepi.htm
Stuart Burnfield <slb -at- westnet -dot- com -dot- au> a écrit :
This sort of context is so important. It's often overlooked because the
person providing the information is so immersed in the context that they
can't picture what it would be like not to have it.
The contextual intro helps not just the person who needs to read the
following material, but also people who *don't* need to read it.
"This chapter contains worked examples of programming XML applications
in a Linux environment. It is suitable for Java programmers with some
knowledge of XYZ who need to learn how to program XML applications in
the following scenarios..."
This sort of intro would help readers not to waste time--for example:
- tech writers who want to know if they could use XML in their
- an XML application programmer who's looking for a programming
reference, but not a tutorial)
Nancy Allison said:
> I had asked the engineer for simple introductory statements to
> provide the missing context for the dense segments of programming
> that followed. In the effort to convey what such a statement
> might be like, I used those comparisons.
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-