Talking Down

Subject: Talking Down
From: "Lisa A. Miller" <lisamil -at- ZEUS -dot- ANET-STL -dot- COM>
Date: Thu, 29 May 1997 17:33:48 -0500

Kevin Freeman wrote:

1. Tighten the wording in each step, stripping out unnecessary dialog
2. When a command is supposed to by typed, put the word Type "xxxxx"

To make a long story longer, she made the comment that we did not
have to put the clarity in Step 2 that I suggested. She goes on to
say that if the developer's need to be told that, then "We hired the
wrong person!"
If she's arguing about the word "TYPE"

If there are a variety of ways to enter information into ClearCase then you
MUST distinguish between the different ways. By this I mean, if you select
some options from a drop-down menu, then use "SELECT." If you TYPE in
another field then, use "TYPE." This distingushes between the two ways to
enter information. But, if you always TYPE information - I would say use
"ENTER" uniformly - but that's my style.

Lisa Miller
lisamil -at- zeus -dot- anet-stl -dot- com

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
Search the archives at or search and
browse the archives at

Previous by Author: Famous Writers and Other People who Once Were Technical Writers
Next by Author: Re: hiring an indexer (semi-long)
Previous by Thread: Re: Simplifying Procedures
Next by Thread: Re: Talking Down

What this post helpful? Share it with friends and colleagues:

Sponsored Ads