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.
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-
