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.
Why do we tech writers suffer from some kind of Note! Gravity, Caution!
Gravity, and Warning! Gravity? Very, very often when I inherit a
document, I find the Notes, etc., at the end of the procedure to which
they apply, sometimes far below the steps they concern. This is not so
bad for notes and cautions, but warnings!
"The users who got electrocuted are going to be mad when they finally
get to the warning!" That's what I always think!
Geez.
Do you see a lot of this?
--Nancy
------------------------------
Kind of like the instructions for pulling the pin on a hand grenade and
throwing the grenade that have a warning *after* the whole procedure
that you only have ten seconds to perform the operation. Well, if you
were smart, you would have read everything before doing anything.
I do believe in putting notes, cautions, and warnings immediately after
the step they apply to, but we're discouraged from breaking up bulleted
and numbered lists. The solution I came up with for something as
important as a warning was to put it before the whole list of steps and
try to phrase it so it applies to the whole general procedure, rather
than to just one step.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-