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.
This may be an unpopular opinion, but would it be possible to drop this
explanation piece completely? I've always tried to discourage unnecessary
up-front explanations, and this sounds a bit like a lead-in to a description
of what a note is (i.e., When you see this symbol xxx, it indicates that the
author has placed a note here. Notes are used to add additional
information...). I know we see this a lot, but can we really expect the
user to either remember the distinctions between the different types of
attention icons, or to flip back to the front for an explanation each time
they run across one? Rather, each warning, caution, or note used in the
document should speak for itself and sufficiently draw the reader's
attention. As a user yourself, have you ever been reading along, and you
run across a picture of a bomb, or a lightning bolt, or something similar,
followed by the word WARNING!!, and had to flip back to the front to see
whether to read the paragraph, or how much attention to pay to it? I'm just
guessing now, but does this document also have a section, immediately before
the actual Table of Contents, that says something like "This document has 17
sections. The first section, Installation, tells the user how to
install..."?
<getting off my soapbox now, and into my asbestos suit...>
^ ^
0 0 I got this powdered water.
> Now I don't know what to add.
\__/ -- Steven Wright
-
Wes Tracy
wtracy -at- cfl -dot- rr -dot- com
> --- Paul Kent <pkent -at- tripathimaging -dot- com> wrote:
> > I'm having trouble with my sentence mechanics. Are there any
grammaticians
> > out there who can weigh in on this?
> >
> > Which of these is correct:
> > There are five notice types used in this manual: three types of warning,
a
> > caution, and a note.
> > There are five notice types used in this manual: three types of
warnings, a
> > caution, and a note.
*** 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.