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: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
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