Re: Grammar?

[Christine -dot- Anameier -at- seagate -dot- com]

I'm with Wes and Karen on this. ("Omit words." I love it!) If I overhaul
existing documents, the first thing I do is delete the "Conventions"
section. IMHO, anything "About This Document" is going to be of little
interest to readers: they don't want to read an instruction manual about
their instruction manual.

I'm guessing you're using symbols to indicate warnings/notes/etc., and this
section is explaining which symbol means what. First of all, I would pare
down the three levels of warnings to two or even one if possible. Then make
the symbols as self-explanatory as possible. If verbal explanation is still
necessary, I'd put something like:
<image of symbol 1> Note: Tips and additional information
<image of symbol 2> Caution: Risk of data loss
<image of symbol 3> Warning: Risk of hardware damage or bodily harm

...and then keep in mind that a lot of your users either won't read or
won't remember your explanation, so you still have to make the meanings
clear enough in context.

Christine


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

A landmark hotel, one of America's most beautiful cities, and 
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe.  http://ieeepcs.org/2001/

---
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.