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.
>Inaccuracies are 100% the direct fault of the
>author(s) and editors. And 99.9% of the time
>its because those writers and editors do not
>understand the technology they are documenting.
>Too much of the work is done in a vacuum with
Close, but not realistic except in a world that is totally without influence
by outside factors of which you have no control.
An author should make every effort to strive for 100% accuracy. This effort
- understand the technology from both a theoretical perspective and from an
- understand how the technology is applied to the situation being documented
- reviewing the technology WITH others (not BY others) who have an even
better understanding of the technology.
Also, part of this responsibility is to accept that errors DO happen
(Andrew..you caught an error today. If you didn't catch one yesterday and
one the day before, you only caught 1 out of 3) and to understand, at every
point in the documentation, that if an occurrence of an error was to happen
at that point, is it of critical or insignificant consequences.
Senior Technical Writer
jposada -at- book -dot- com
"When you only have two minutes to do
something that takes three, wait until you have three"
This article has a number of questionable assumptions. But the big one is:
"Because I am a technical writer, I understand that inaccuracies are not
necessarily the fault of the writer, or even the editor. "
Inaccuracies are 100% the direct fault of the author(s) and editors. And
of the time its because those writers and editors do not understand the
technology they are documenting. Too much of the work is done in a vacuum
editors who won't "dirty their hands" with technology or writers who
consistently misunderstand how to use the very products they're documenting.
Purchase RoboHelp X3 in April and receive a $100 mail-in
rebate, plus FREE RoboScreenCapture and WebHelp Merge Module.
Order here: http://www.ehelp.com/techwr-l
You are currently subscribed to techwr-l as:
archive -at- raycomm -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.