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: Sentence structure: Indeed it depends From:"Dave L. Meek's User Account" <dave -at- ROGUE -dot- DISC-SYNERGY -dot- COM> Date:Mon, 26 Jun 1995 15:40:26 -0700
Tracey May wrote:
>It may mean _very little_ at the user level, but usually it means
>_something_. When I encounter documentation that merely
>tells me what to do, and not why, I feel as if I'm missing
>something. I want the big picture.
>Most of the people I know enjoy learning. I don't think it's our role to
>simplify everything to the point that our users are unable to grasp
>the concepts behind the technology we're walking them through,
>that they're not able to see similarities in processes because they
>don't understand the processes themselves.
>It's a little more work to explain why something should be done,
>but I think it's worthwhile. I'm not saying we have to turn user
>guides into text books, but I think it's reasonable for us to
>explain succinctly why a particular action should be taken.
>Putting an explanation after the action works for me.
I agree with all of Tracey's points except the last one. If I
don't know why I'm doing something, I find it difficult to repeat
the task without referring back to the manual. That's
frustrating; at some point, I want to save time by just doing the
task, or I'll want to adapt the procedures to fit a special
circumstance or need. In a modular design, knowing the "why"
lets the user "mix and match" without having a specific procedure
for each circumstance.
My one point of divergence from Tracey is I *usually* prefer
knowing the "why" just before the action. Otherwise, the
question of "why" is on my mind until I find out, which keeps me
from fully concentrating on the item at hand. Of course, this is
a personal preference that might not be typical.
/
----- /
c-----O| |\____________________________________________/
L_____| | |
| | |
\__/ |
\ |_______________________________________| |
| | | |
^-- ^--
"Get a long little doggie!"
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Dave Meek