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: What's important From:"Susan W. Gallagher" <sgallagher -at- EXPERSOFT -dot- COM> Date:Mon, 23 Jun 1997 16:39:41 -0700
David Tillyer writes:
>
><< What would you say was the most important thing for technical people
> to know about writing clearly and accurately? Do you have any tips
> that you give your technical, non-writer, colleagues? >>
Two tips spring immediately to mind:
* Don't include unnecessary information. So often, techies get
caught up in the details of the implementation rather then
the steps it takes to get the job done. If the user doesn't
really need the information, you probably shouldn't include it.
* Construct "right-branching" or "forward-moving" sentences and
paragraphs. If you can somehow get the movement of a sentence/
paragraph across to them, you'll clear up a lot of pesky little
grammar problems, including passive voice.
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
