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.
Accept your fate as technical writer and learn to enjoy the rhythm of
procedures. It isn't such a chore when your professional self-esteem is
tied to values like "thoroughness" (especially in the analysis of the
task), absence of ambiguity in each documented instruction, and clarity
of presentation.
======================
In the last install procedure I did...the one for the mainframe, we have
someone named "Pat" (why Pat? That's his name!). Pat's job is to package
all the files, databases, documentations, PDFs, license contracts,
readmes, setups, EXEs, etc., on the CD, then to test the package.
Since many of the documentation and help files are compiled into the MSI
file and installed as part of the process, he usually tests the
installation process. Our last conversation went something like:
Me: "Pat...you test the installation?"
Pat: "Yep"
Me: "How'd it go?"
Pat: "Fine"
Me: "You use my instructions?"
Pat: Yep"
Me: "Everything went well?"
Pat: "Yep"
Me: "No questions?"
Pat: "Nope"
Me: "Do I need to make any changes?"
Pat: "Nope"
I LOVE those conversations. It made the 6days/14pages of install
instruction writing all worth while.
John Posada
Senior Technical Writer
Isogon Corporation http://www.isogon.com
"Realizing Your Business Goals
Through Software Asset Management"
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more. http://www.doctohelp.com
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
