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: "do not do x" vs "never do x" From:"Butler, Darren J CTR USAF AFMC 584 CBSS/GBHAC" <Darren -dot- Butler -dot- ctr -at- Robins -dot- af -dot- mil> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 25 Jun 2008 15:27:12 -0400
Words such as "never" are included in Warning statements. If the
prohibited action is something that will produce an adverse result ANY
and EVERY time that it is preformed, then use negatives such as "never"
or "under no condiion should you...." This also may include "right-tool,
wrong-time or wrong-job' situations. As Victoria has pointed-out, time
is a factor.
Ex: "If animal is not heavily sedated, NEVER use the Model D-1P Bear
proctology kit " or " AT NO TIME should the operator use an H3-lp road
flare to check the level of the fuel tank"
Phrases such as "Do not" or "Must Not" may be either be a Caution
statement, or a Warning. Time-in these cases-may be more conditional.
Ex: "DO NOT use the D-1p until the bear is comatose" or "Driver MUST
NOT ignite road flares unless he/she has exited and cleared the
vehicle"
As Gene pointed-out, Warning statements should ALWAYS.......;^).......be
highlighted in such a way that draws attention to itself and further
emphasizes the statement.
Darren J Butler
-----Original Message-----
From:
techwr-l-bounces+darren -dot- butler -dot- ctr=robins -dot- af -dot- mil -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+darren -dot- butler -dot- ctr=robins -dot- af -dot- mil -at- lists -dot- techwr-l -dot-
com] On Behalf Of Milan Davidovic
Sent: Wednesday, June 25, 2008 2:02 PM
To: TECHWR-L
Subject: "do not do x" vs "never do x"
Of the two ways of telling someone not to do something:
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
Darren -dot- Butler -dot- ctr -at- robins -dot- af -dot- mil -dot-
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-