RE: Most illogical documentation

Subject: RE: Most illogical documentation
From: "Dori Green" <dgreen -at- associatedbrands -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 2 Jul 2007 08:45:14 -0400

Nancy Allison wrote:

I am also quite fond of the warnining that is placed at the end of the procedure. As in--after you've finished making your electrical connections--"WARNING! Connect the yellow connector first, to minimize the danger of electrocution."


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

That's exactly why the MIL STD for placement of warnings in techdocs was (still is?) _before_ the step containing the hazard. Notes go after, cautions (possible hazard to equipment or product) and warnings (possible hazard to people) go before.

I think this came from the Navy. Lost too many midshipmen and it's hard to replace a good electrician in the middle of the ocean. At least that's what my father the Lt. J-G told me. But he also told people that the garage sale painting in the living room was the family castle on the Rhine, and that our family name meant "Big Wind Over the Alps".

Dori Green
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


Previous by Author: RE: Most illogical documentation
Next by Author: RE: Lack of self-awareness in a writer...what to do
Previous by Thread: RE: Most illogical documentation
Next by Thread: RE: Most illogical documentation


What this post helpful? Share it with friends and colleagues:


Sponsored Ads