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.
RE: When they shouldn't be experimenting (was RE: Encouraging lea rning by experimentation?
Subject:RE: When they shouldn't be experimenting (was RE: Encouraging lea rning by experimentation? From:Richard Lippincott <richard -dot- lippincott -at- ae -dot- ge -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 6 Dec 2002 09:56:27 -0500
>From /kevin:
>So, for the moment, they've settled on "command
>first, notes-and-warnings after".
>How do the rest of y'all deal with that
>particular dilemma?
In most of my tech writing career, I haven't had to face that as a dilemma
because there's been a spec that governed it: either a milspec like
MIL-M-38784, or a commercial aircraft spec like ATA 100, or a Bellcore spec
like TR-TSY-000454. All of them call for the Warnings, Cautions, and Notes
to precede the step.
When working in shops that are not covered by any one of those specs, they
can still be used as a strong argument for placing the admonitions before
the step. Particularly as I'm not aware of any spec that mandates having the
admonition come -after- the spec, so it's harder for the other side to
counter the position.
--Rick Lippincott
Lockheed Martin
Saugus, MA
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 in December and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
