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.
Subject:RE: International standards for caveats From:Mary Ellen Schutz <me -dot- schutz -at- juno -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 5 Feb 2008 10:47:08 -0600
Ronald Schwarz" <RSchwarz -at- cosmocom -dot- com> writes in part:
Can someone please remind me of the international standards governing
the use of caveats in user documentation? I need both the standards and
the content. The standards can include engineering standards. For
example, when can we use Note, Information, Warning, or Caution? The
type of warning and the icon that accompanies it are what I need.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The European Union/European Nations standards have been adopted pretty
much worldwide for notices in manuals and on safety labels. The
particular standard number depends on the country you're trying to clear
regs for and the type of device. But check with your engineers for the
CE mark (EN) or ANSI standards they're designing to...The US standard for
labeling is ANSI Z535. That said, here are the definitions for the flag
words that are now standard for goods shipping to Europe, USA, Korea,
Japan, China (PRC and Taiwan), Canada...
Notice (replaces Important, Information, or whatever else you were using
if you're planning on getting a CE mark)
Follow instructions labeled ?Notice? to avoid damaging the system
hardware or losing data.
Caution
Indicates a hazardous situation which, if not avoided, may result in
minor or moderate injury. It may also be used to alert against unsafe
practices.
Warning
Indicates a hazardous situation which, if not avoided, could result in
death or serious injury.
Danger
Indicates a hazardous situation which, if not avoided, will result in
death or serious injury.
Caution, warning, and danger (the flag words that indicate personal
injury is possible) are preceded by a triangle with an exclamation point
inside. In color, yellow triangle, black exclamation point. For
labeling, color comes into play as well, with the flag word and icon
required in color field at the top of the label...Caution, black text in
yellow field, Warning black text in an orange field, and Danger, black
text in a red field. Cautionary text must include a description of the
hazard and the steps necessary to avoid injury or death. That panel must
be white with black text. There must also be a panel with either the
international warning symbol for the hazard or a pictograph that makes
clear what the hazard is.
Gee...you suppose 20+ years of documenting computers and scientific
instruments intended for CE mark left its mark?
Mary Ellen Schutz, your Gentle Editor
Gentle Editing, LLC
www.GentleEditing.net
608.695.8254
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It is easier to build strong children than to repair broken
men...Frederick Douglass
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-