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: Help for a new tech writer From:"Nicola Harlow" <N -dot- Harlow -at- seamsltd -dot- com> To:"Jim Mezzanotte" <jmezzanotte -at- wi -dot- rr -dot- com>,<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 5 Mar 2008 08:56:33 -0000
Test, test and test again :)
Find some willing guinea pigs and let them try them out. Get them to
talk through what they are doing, and scribble notes like hell on a
copy!
In my first job I forgot one step that rendered the rest of the
instructions useless (press 'enter' after putting in the password!)
Thankfully it wasn't life or death, but it taught me a lot.
If you can get direct access to users, that's possibly the most valuable
experience ever. You may never get it at other jobs :)
Nicola
-----Original Message-----
From: techwr-l-bounces+n -dot- harlow=seamsltd -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+n -dot- harlow=seamsltd -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Jim Mezzanotte
Sent: 04 March 2008 16:59
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?
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 N -dot- Harlow -at- seamsltd -dot- com -dot-
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.
This e-mail and any files transmitted with it are confidential and intended solely for the use of the addressee. If you are not the intended addressee, or the person responsible for delivering it to them, you may not copy, forward disclose or otherwise use it or any part of it in any way. To do so may be unlawful. If you receive this e-mail by mistake, please advise the sender immediately. Skipworth Engelhardt Asset Management Strategists Limited (SEAMS Ltd) is not responsible for any changes made to the message after it has been sent. Where opinions are expressed, they are not necessarily those of SEAMS Ltd. SEAMS Ltd make no representation that this e-mail or any attachments are free of viruses and virus scanning is recommended and it the responsibility of the recipient. Skipworth Engelhardt Asset Management Strategists Limited. Registered office: Ash House, Hallamshire Court, Sheffield, S11 8HA UK. Registered in England no: 4097101
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-
