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.
Judy Morgon writes:
> We design step-by-step user manuals. Our style is present tense. Can a
> dialog box "display" or just appear? For example:
> 1. Click Next. The Setup dialog box displays.
> (I've been told that "display" is not accurate. The dialog box
> displays what?)
I agree with the nay-sayers. Display is a transitive verb, and should not
be used as an intransitive. You can avoid this problem by combining the
sentences. However, this brings up other issues.
I believe we had a thread on this sort of thing a couple of months back.
The best rule I could extract from the ensuing uproar goes something
like this.
If the action is optional, give the results then the action. In your
example, this would read:
"To display the Setup dialog box, click Next."
If the action is required, reverse the order.
"Click Next to display the Setup dialog box."
Anyway, this solution puts things in a nice active voice, and removes most
ambiguity. More information than you really asked for, but I'm just trying to
prevent an instant replay of a tiresome thread.
Pete Kloppenburg - pkloppen -at- certicom -dot- com
Technical Writer
Certicom
Mississauga, Ontario
Canada
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html