RE: Help for a new tech writer

["Karen Murri" <kmurri -at- comcast -dot- net>]

I'm a bit jealous. My first tech writing job was in manufacturing and I
rather miss it. I think you'll do fine.

You've gotten some great tips so far. Here are a couple other things to
think about:

Quick reference guides might be your first step. Quick reference guides can
be placed at the machine and glanced at for important operational
information. 

Find out about your workforce. I think someone mentioned that they might not
need itty-bitty detail. Think in terms of procedures that cover "what to do"
versus procedures that say "how to do it." You might need one or the other,
and in some cases both.

Take advantage of the documentation that comes with the equipment. Some of
it will be pure crap, but it's better than nothing. If you didn't get any,
bug the equipment vendors and installation contractors until you do.

Learn to write. You might think you already do well enough, but I can almost
guarantee you've got more to learn. Make sure you learn about writing
procedures and how to write them clearly (without a lot of wordy flotsam and
jetsam). Here are a few writing subjects to look up: active voice (use it),
second person imperative (for procedure steps), deadwood (don't use it), and
telegraphic style (don't use it).

Good luck and have fun.

-Karen 



-----Original Message-----
From: techwr-l-bounces+kmurri=comcast -dot- net -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+kmurri=comcast -dot- net -at- lists -dot- techwr-l -dot- com] On Behalf Of
Jim Mezzanotte
Sent: Tuesday, March 04, 2008 10:59 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Help for a new tech writer

File this under "careful what you wish for." I've been trying to break into
technical writing, and now I've plunged right into the deep end. I'm working
for someone who is gearing up a manufacturing plant from scratch, and he
needs complete documentation for every operation that will take place there.
Seventy people will be operating the plant when it is up and running. My
background is in print publishing--minimal proficiency in Quark, and that's
it. He's leaving the software choice--and everything else--up to me.

Am I nuts to take this on? I will be starting slowly, a few days a week,
with research at the plant. All the info I will need is essentially in the
owner's head, so I will be doing extensive interviews with him. But I need
to get the right software and a template to work with so I can at least
start plugging things in to some kind of structure. I'm wondering about
Framemaker or Indesign.

I know I haven't given much info (I don't have much yet), but anyone have
advice for me?   

--New (mildly panicked) tech writer


No virus found in this outgoing message.
Checked by AVG Free Edition. 
Version: 7.5.516 / Virus Database: 269.21.4/1310 - Release Date: 3/4/2008
8:35 AM
 

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/ for more resources and info.