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: STYLE GUIDE FOR COMPUTER MANUALS From:Chuck Banks <chuck -at- ASL -dot- DL -dot- NEC -dot- COM> Date:Thu, 1 Jul 1993 09:54:29 CDT
Hi, Janie!
It's me again.
A thought occurred to me that you may not have been
briefed on the policies and procedures your company's
software/hardware developers follow.
Nothing alienates a Subject Matter Expert (SME) faster
than evident ignorance of their jobs and processes on
the part of a Tech Writer trying to interview them.
If you don't already have a copy of the design procedures,
get one. Study it. Even if it's out of date, and no one
follows it strictly, it will give you a basis for
discussions with your development personnel.
Then, go meet with the developers. Have coffee. Talk
about the weather. Then ask them where they are in
the process, what phase have they reached?
You'll make points because you've obviously done your
homework and you'll understand their jargon which will
make the communication process simpler and impress
the developers even more.
Good Luck!
Chuck Banks
--
__ ________ ______
|\\ | || // Chuck Banks
| \\ | ||_______ || Senior Technical Writer
| \\ | || || NEC America, Inc.
| \\| \\______ \\______ E-Mail: chuck -at- asl -dot- dl -dot- nec -dot- com
America, Incorporated CompuServe: 72520,411
