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: POLL: A question of rhetoric (not a rhetorical question)
Subject:RE: POLL: A question of rhetoric (not a rhetorical question) From:"Dan Hall" <dhall -at- san-carlos -dot- rms -dot- slb -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 6 Nov 2001 07:03:15 -0600
I thought I'd chime in on this, as I too am wary of
the "be positive" POV.
I think it depends more on what you're documenting, and
the consequences of doing the wrong thing. It's fine to
say "You can enter a keyword in the blahblah box" instead
of "Don't enter more than one keyword..." when there's
really no great danger of data loss or injury.
You might be more "negative" when it comes to, say, data
security. "Do not give out your password under any
circumstances" is stronger than "Keep your password
secret" (IMO)
Here at SchlumbergerSema, one of our products is a radio-
frequency controlled RTU - a big distribution switch that
turns on or off high power (kV) lines - those big lines
you see running across the desert on 200' towers.
If someone makes a mistake while using the software that
controls these things, you could turn the power out for
a significant portion of a large metropolitan area. You
could also kill someone - if the switch closes while
they're working on the "off" side.
In a case like that, we have large, red, all-caps cautions
that say "Do not attempt to switch the RTU without
clearance from the utility... Severe injury or death
could result. And in the text, I also say "Do not..."
Frankly, I'm with Kevin - I can't wait for e-paper so
these warnings can really flash.
Dan
Have something to say, and say it as clearly as you can.
That is the only secret of style. -- Matthew Arnold
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Be a published author! iUniverse gives you: a high-quality paperback, a
custom cover design, and distribution to 25,00 retailers. Join our almost
10,000 published authors today. http://www.iuniverse.com/media/techwr
---
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.