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:AnnMacknz -at- AOL -dot- COM Date:Mon, 23 Jun 1997 18:50:05 -0400
David Tillyer writes:
>>I've been thinking about my students at City College here in New York.
They're all either engineers or computer science majors. They are not
headed for technical writing careers, but they are taking a technical
writing course.
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?>>
Hi David -
IMO the most important things for technical people to know about writing are:
1. Always start with a "road map", an outline of what you plan to write.
(You might even want to show them different ways of coming up with a writing
plan.)
2. Remember what your audience *does not* know. Never assume knowledge on
the part of your readers that may not be there.
3. When explaining anything, use short sentences and simple words whenever
possible. No one should be offended by clarity.
Should think that would take your engineers and compsci majors a long way.
Cheers Ann
==========================
Ann Mackenzie: AnnMacknz -at- AOL -dot- com
TekDoc - Technical Documentation, Inc. in Milwaukee, WI, USA
specializing in policies & procedures and software & engineering writing
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
