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:Sentence structure: Indeed it depends From:Mark Levinson <mark -at- SD -dot- CO -dot- IL> Date:Mon, 26 Jun 1995 18:22:32 IDT
Geoff Hart says "As always, Karen, it depends" and provides
some examples.
Another example would be a procedure in which-- as in many
I've seen, and perhaps in some you've seen-- the user is
called upon to perform steps the individual purpose of which
means very little at the user level.
For example, to install a new software product may involve
typing twelve commands and be documented in fifteen steps.
Half the commands may be commands that the user is not
expected to be familiar with otherwise. Let's say that in
this context the user needs to type a particular command
that decompresses some data files. You could say,--
4. Now you need to decompress your data files.
To do so, type dcmprs.
But why force the reader to deal with that extra explanation of
an interim step of the procedure, when all that interests
the user is the ultimate result of getting the software installed?
You could say just--
4. Type dcmprs.
That is, don't ask questions. Just do it. But if you were
feeling avuncular, you could put the explanation after the
action:
4. Type dcmprs. The dcmprs (decompress) command translates files
out of the especially compact form they were delivered in
and into a form that can be used.
Then the user gets the important information up front and can
treat the rest more casually.
__________________________________________________________________________
||- Mark L. Levinson, mark -at- sd -dot- co -dot- il -- Box 5780, 46157 Herzlia, Israel -||
|| - Death to fanatics! - ||