Help for a new tech writer

[Leonard C. Porrello]

Perhaps because you are new to tech writing, the idea that keeps popping
into my head is safety. Be sure to be proactive in finding out ...

*         what can go wrong

*         how people might get hurt

*         how equipment or product might be damaged

 

If you do end up with many relatively short processes (as Gene
suggested) and most processes do not happen in isolation, be sure to
include the current process' relationship to upstream process and
downstream dependencies. As Al suggests, photos, illustrations, and
process flow diagrams will probably be essential. To the extent that you
can communicate clearly pictographically along with or instead of with
words, that would be the way to go. 

 

Leonard C. Porrello

SoleraTec LLC

www.soleratec.com

 

 

 

-----Original Message-----
From: techwr-l-bounces+leonard.porrello=soleratec.com at lists.techwr-l.com
[mailto:techwr-l-bounces+leonard.porrello=soleratec.com at lists.techwr-l.c
om] On Behalf Of Al Geist
Sent: Tuesday, March 04, 2008 10:44 AM
To: techwr-l at lists.techwr-l.com
Subject: RE: Help for a new tech writer

 

Go for it. You don't need a specialist. All you need is the ability to

describe processes and interview effectively. You already said that most
of

the information is in your bosses head. Drain his (her) brain. Diagram
out

the process flow. As Paul Kretschmer said, get a digital camera for
those

processes that are already in place. Write up your drafts and run them
by

your boss. It may take a few tries, but pretty soon you'll be providing
what

he wants....and after all, he signs the paychecks.

 

Al Geist

Technical Writing, Help, Web Design, Video, Photography

Office/Msg: 802-872-9091

Cell: 802-578-3964

Website: www.geistassociates.com

See Also:

Fine Art Photography

Website: www.geistimages.com

 

"...I walked to work, quit my job, and kept walking. Better to be a
pilgrim

without a destination, I figured, than to cross the wrong threshold each

day." (Anon.)

 

 

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

 

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
Leonard.Porrello at soleratec.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/leonard.porrello%40so
leratec.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.