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.
Are icons necessary or desirable? Using an icon forces the reader to
remember what the icon means, or look somewhere in the doc to find out.
We just use the words -- WARNING, CAUTION, NOTE -- with style changes to
make them stand out from regular paragraphs.
Of course, even with using words, the user has to remember the
difference between WARNING and CAUTION or DANGER. However, this should
be obvious from the statement immediately following the word/icon.
A dummy page is a good idea. If I find myself using too many special
statements on a single page, I evaluate and restructure the info so the
impact of the important statements is not lost.
e'mail: jsbrooks -at- ingr -dot- com
>From: Wayne J. Douglass[SMTP:wayned -at- VERITY -dot- COM]
>Sent: Wednesday, April 30, 1997 4:11 PM
>To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>Subject: Re: Icons
>At 03:30 PM 4/30/97 -0500, Rob wrote:
>>The manuals I have consulted define "warning, "caution" and "note" but do
>>provide examples of generally accepted icons for each. Can you tell me,
>>the following descriptions, if the icons we are creating are acceptable?
>>WARNING: a triangle with an exclamation point inside it.
>>CAUTION: a triangle inside another triangle.
>>NOTE: the word "note" with a triangle pointing to the text to the right.
>>(lots of triangles!)
>In general, when I see cute icons I reach for my air sickness bag, but I'm
>surely in a minority here.
>Do yourself a favor, Rob. Create a dummy page where you use all of your
>icons and see what it looks like. What seems like a good idea where there is
>only one icon per page can look pretty awful or silly when there are more
>Verity, Inc. Email: wayned -at- verity -dot- com
>894 Ross Drive Telephone: 408-542-2139
>Sunnyvale, CA 94089 Facsimile: 408-542-2040
>Connecting People with Information: http://www.verity.com
> TECHWR-L (Technical Communication) List Information: To send a message
>to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
> to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
> Search the archives at http://www.documentation.com/ or search and
>browse the archives at http://listserv.okstate.edu/archives/techwr-l.html