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.
Fire guides? Be rigorous when human lives are involved.
Subject:Fire guides? Be rigorous when human lives are involved. From:"Geoff Hart (by way of \"Eric J. Ray\" <ejray -at- raycomm -dot- com>)" <ght -at- MTL -dot- FERIC -dot- CA> Date:Wed, 2 Dec 1998 10:15:03 -0700
David Dick is <<...writing a user guide that describes how a building
is set-up with fire extinguishing equipment, how it works,
installation, etc. Does anyone have any suggestions on how to
structure such a document?>>
Well, my first thought is that you really, really don't want to
produce the guide on paper or anything else flammable... <gdr>
Seriously though, on the whole, I don't see any need to create
something much different from your typical user guide for hardware or
software. Start with an analysis of the needs of the product's users,
and structure your document around the results of the analysis.
The main exception is that human lives will depend on the success of
the installation and (very important!) subsequent maintenance, so
you'll have to be RIGOROUS in getting the technical reviews done
right. It might even be worthwhile talking to your local fire
department's safety inspector to get feedback from a professional
who has to live with the consequences of such guides and who can
provide a list of criticisms of other company's guides. Similarly, be
rigorous about identifying ways to troubleshoot the system (both
immediately after installation and as part of ongoing maintenance);
you're probably going to save lives as a result of the extra effort.
After all, nobody really cares if Word crashes yet again, but if
there's a fire...
--Geoff Hart @8^{)}
geoff-h -at- mtl -dot- feric -dot- ca