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: help with a strong word From:"Chalmers, Eric" <Eric -dot- Chalmers -at- WESTGROUP -dot- COM> Date:Thu, 12 Aug 1999 16:17:59 -0500
Several clever (and cathartic ) answers have already been posted regarding
this topic, but this Digest Lurker is pitching in his two cents just the
same. As Chuck pointed out:
>> I assume that you have established icons to indicate levels of risk
>> (where it exists), such as the typical "caution," "warning," and
>> "danger" icons. (Incidentally, "danger" is supposed to be used only for
>> indicating where there is actually physical risk to the user.)
>>
>> I would use the appropriate icon along with explanatory text...
In addition to these icons, I would include a Stop sign icon. Follow the
icon with an appropriate explanation of the potential problems that can
result from doing the tasks incorrectly. Be clear, be direct.
<< Chuck goes on to say >>
>> You do have to allow your users to take responsibility for
>> their own actions. Just tell them what they need to know, tell them that
>> what they are doing is risky, explain how to complete the procedure
>> correctly, and move on.
I agree completely. Anything beyond this will clutter your instructions,
which in turn leads to your audience not reading the instructions.
-e-
<<original message from K. McGowan>>
Hi Tech Writer folks,
We have to document a dangerous software procedure, and want to come up with
a title that will sufficiently frighten the user. Basically, this is a
software application, and only the system administrator can perform this
function, and he/she must do it VERY CAREFULLY.
Something like "F---ing with the server" comes to mind, but is a little too
strong and potentially offensive. Any suggestions?
Yes, we must document this, and yes, there will be warnings all over it, but
we need a title that clearly says "don't do this" without actually saying
"don't do this."