Help for a new tech writer

[Paul Kretschmer]

I've done industrial prccedure docs before, and this is my advice:

Get a digital camera, and learn how to integrate pictures into your
docs.  A picture is worth a thousand words.  (One picture per step is
not too much.) 

I also think Gene Kim-Eng's advice is very good (write short docs in
Word).  

-----Original Message-----
From: techwr-l-bounces+paul.kretschmer=yardi.com at lists.techwr-l.com
[mailto:techwr-l-bounces+paul.kretschmer=yardi.com at lists.techwr-l.com]
On Behalf Of Jim Mezzanotte
Sent: Tuesday, March 04, 2008 8:59 AM
To: techwr-l at lists.techwr-l.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


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

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 Paul.Kretschmer at yardi.com.

To unsubscribe send a blank email to 
techwr-l-unsubscribe at lists.techwr-l.com
or visit
http://lists.techwr-l.com/mailman/options/techwr-l/paul.kretschmer%40yar
di.com


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

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