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:Estella Clifford <cliff -at- FP -dot- COM> Date:Wed, 28 May 1997 11:48:03 EST
In reply to:
<snipped>
>
> 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!"
>
What happens when a new developer is hired? One who has plenty of
ability, but perhaps not familiarity with:
- the specific software tools (i.e., ClearCase) your company uses, or
- the specific procedures used at your site?
IMHO, adding your "Step 2" for clarity would make your document useful
to a much broader audience with just a little effort. It could save time
and money by getting potential new developers up to speed faster, too.
Just a couple thoughts.
Regards,
Estella
Sr. Technical Writer
e-mail: clifford -at- fp -dot- com
My opinions are my own . . .
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
