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.
Sybille Sterk has <<...a dispute at work. So far I have avoided the future
tense wherever possible, because from what I gathered it is not used in
technical documentation as it expresses a certain amount of doubt like it is
expressed in "may" or "might".>>
The problem of future tense is not that it might be misinterpreted as "may
or might", which is possible but quite unlikely for anyone with English as a
first language. There are, however, two commonly cited problems: first, it
is generally passive (will be displayed = by whom or what?), and second, it
provides no clear indication of time (will be = when... in 10 minutes? after
I get mad and pound on the keyboard?). The second objection strikes me as
weak; the first one is more serious, in part because you should always try
to make the actor clear whenever that's relevant, and in part because
passive voice is generally wordier than active voice.
<<"When you click the X button the X dialog is displayed">>
Nothing seriously wrong with this, though some frown on "when" constructions
because (i) the display appears _after_ you click, not _when_ you click, and
(ii) this is descriptive/narrative (telling a story) rather than imperative
(telling someone what to do). Imperative voice is usually better because it
speaks more directly to what the reader wants: task-based instruction. (The
descriptive approach is more appropriate for general instruction in which
you're providing a context or overview rather than for task-based
instruction.) My preference for steps in procedures is as follows:
For an introductory step: To print [optional: your document], click the X
button. The X dialog appears.
For an intermediate step: Click the X button. In the dialog that appears,
[continue the instructions]
<<When you click the X button the X dialog will be displayed>>
Again, the problem with "when". "Once you have clicked" would be more
grammatically correct if you prefer this style. Again, "appears" is much
shorter than "will be displayed", is much more direct, and eliminates any
uncertainty (will = will eventually, appears = it's going to happen now, in
response to what you just did). I've seen some argument against "appears"
(e.g., "appears to be what?"), and had reservations about this verb myself
back when I began techwhirling, but I now find the arguments unconvincing.
If you're skeptical, "will display" is perfectly acceptable, since "display"
is both transitive (the most commmon form) and intransitive (as here). You
can also say "Word displays the print dialog box" to identify the actor, but
naming the application isn't often necessary.
--Geoff Hart, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca
"The paperless office will arrive when the paperless toilet