[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Attention-getters: Warning, caution, danger...

Subject: Re: Attention-getters: Warning, caution, danger...
From: "Barry Campbell" <barry -dot- campbell -at- gmail -dot- com>
To: "Yves Barbion" <yves -dot- barbion -at- gmail -dot- com>
Date: Mon, 28 Aug 2006 08:46:41 -0400

On 8/28/06, Yves Barbion <yves -dot- barbion -at- gmail -dot- com> wrote:

Are there any other references that clearly describe the use of "caution",
"warning" and other attention-getters?

It's been many years since I worked on an IBM document (over 15!) but
back in the day, IBM's in-house style guide used similar
conventions... "caution" is something that can mess your work up,
"warning" is something that can mess you up, "danger" is something
that can kill you, etc.

We use Microsoft as our in-house style guide where I work now, and
while we occasionally use caution statements, we don't have a need for
anything stronger, as nothing that you can do with our products or
services can endanger your health (unless you hurt yourself by banging
your head against your desk after you mess up a lengthy installation.)

I think that explaining the conventions up front in your documentation
and calling out your caution and warning statements in a really
eye-catching way (with a big box around them, with a graphical icon,
offset from the regular text block, some combination of these),
combined with a clear and unambiguous statement of the nature of the
threat, is all that's required.

- bc

--
Barry Campbell <barry -at- campbell-online -dot- com>
http://campbell-online.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.

References:
Attention-getters: Warning, caution, danger...: From: Yves Barbion

Previous by Author: Re: Looking for a senior tech writer mentor
Next by Author: Re: Bulletin metadata question
Previous by Thread: Attention-getters: Warning, caution, danger...
Next by Thread: Re: Attention-getters: Warning, caution, danger...

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

What this post helpful? Share it with friends and colleagues:

Sponsored Ads