Most illogical documentation

Dori Green dgreen at associatedbrands.com
Mon Jul 2 06:45:14 MDT 2007


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


More information about the TECHWR-L mailing list