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:Re: Clarity or Talking Down? From:Tracy Boyington <tboyi -at- OKVOTECH -dot- ORG> Date:Wed, 28 May 1997 10:46:47 +0000
> 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!"
Kevin, the answer to this debate may be in your first paragraph:
>The developers complained
>that the procedure didn't work.
If the developers understand *without* the changes you suggested in
step 2, then it isn't necessary. But if they're still having
problems, it should be easier to justify that extra measure of
clarity.
Tracy
==========================================================
Tracy Boyington tracy_boyington -at- okvotech -dot- org
Oklahoma Department of Vocational & Technical Education
Stillwater, Oklahoma, USA http://www.okvotech.org/cimc/home.htm
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
