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: Consequences of inadequate docs/training From:"Martin Page" <mpage -at- csl -dot- co -dot- uk> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 27 Mar 2002 14:14:35 -0000
"Tom Murrell"
> The documentation would have the biggest Danger Warning I could put in it.
I haven't seen any modern weapons manuals, but they must be full of
warnings - e.g. "Don't call down an air strike within 50m of your position."
"Establish positive identification before firing on target" and so on.
So, how do you avoid overloading the manuals with warnings and cautions to
the extent that you make the reader blasé or destroy their faith in the
equipment?
(This probably also applies to other critical real-time systems, e.g.
medical software)
"Tom Murrell" <trmurrell -at- yahoo -dot- com> wrote in message news:147501 -at- techwr-l -dot- -dot- -dot-
>
> --- Martin Page <mpage -at- csl -dot- co -dot- uk> wrote:
> >
> > Surely the GIS machine should have been designed so that controllers
> > couldn't call down airstrikes on themselves.
> >
> > We're talking about a real time, high-stress and high-fatigue situation
and
> > a design that's the equivalent of having the rifle muzzle swing around
to
> > point at the user every time the magazine empties.
> >
> > If you were documenting the device in question, how would you highlight
this
> > potentially lethal feature so that you could sleep at night?
>
> First, I would fight like hell to have the device redesigned to be safer
for
> the user. Barring that, I would make damned sure they understood, in
training,
> how it worked and what the consequences of such a reset would be.
>
> The documentation would have the biggest Danger Warning I could put in it.
>
> (Oh, and I don't particularly appreciate the flippant responses some have
given
> this question. In my opinion, it's a serious writing/training/design
issue.
> This is one of those situation where you not doing your job
properly--leave
> your politics at the door when you take the job--can get people killed.
>
> How would you sleep then? Huh?)
>
> =====
> Tom Murrell
>mailto:tmurrell -at- columbus -dot- rr -dot- com
> Personal Web Page - http://home.columbus.rr.com/murrell/index.html
> Page Last Updated 03/14/02
> "Technical Writers: Writers who get paid a living wage."
>
> __________________________________________________
> Do You Yahoo!?
> Yahoo! Movies - coverage of the 74th Academy Awards®
>http://movies.yahoo.com/
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
PC Magazine gives RoboHelp Office 2002 five stars - a perfect score!
"The ultimate developer's tool for designing help systems. A product
no professional help designer should be without." Check out RoboHelp at http://www.ehelp.com/techwr
---
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.