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: "Button Gravity" and "Warning Gravity" From:Nancy Allison <maker -at- verizon -dot- net> To:"Butler, Darren J CTR USAF AFMC 584 CBSS/GBHAC" <Darren -dot- Butler -dot- ctr -at- Robins -dot- af -dot- mil> Date:Tue, 16 Dec 2008 14:20:15 -0600 (CST)
Darren says:
> My problem is when a warning or caution paragraph (i.e. electrical
> hazards) is placed at the very beginning of a lengthy procedure,
> sometimes several steps - even pages - away from the application. . .
> .
> DoD documents are mandated to have Cautions ("you could jack something
> up") and Warnings ("You could jack yourself up") immediately precede
> an
> applicable procedure. Is there an equivalent standard in the
> commercial
> world?
>
> -Darren
I dunno about the entire commercial world, but in Nancy World, warnings
immediately precede the step they pertain to, and if they are a bit ugly
and definitely disrupt the flow, so much the better!
I don't want anyone tastefully and seamlessly electrocuting themselves
because of a tasteful and seamless warning in one of MY documents!
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-