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: Documenting installers? From:eric -dot- dunn -at- ca -dot- transport -dot- bombardier -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 25 May 2004 11:33:35 -0400
John Posada wrote:
> ...don't assume that because the product is
> technical, that the users "must" be as technical.
And don't repeat the oft-made mistake or repeat the old TECHWR-L
stereotype of what technical means. Technical DOES NOT necessarily mean
computer/software technical.
Your users might be absolute aces when it comes to brain surgery, rocket
science, or taxation code. They may know NOTHING about
computers/installers or how to configure them. This is not a bad thing.
They are employed for their other knowledge/talents and shouldn't
necessarily be expected to learn anything involving back-end computer
knowledge.
It's the oft-missed technology to technology bridge that IMO is the most
important role of a technical writer. If your instructions aren't being
understood by your audience, it may not be because the audience isn't
"technical". It could be that the technical writer failed to translate
from the technology used to create the tool to the technology/domain the
tool is used in.
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.
