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.
Wanted: "Right" Standards for User Manual (appliance)?
Subject:Wanted: "Right" Standards for User Manual (appliance)? From:Geoff Hart <ghart -at- videotron -dot- ca> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 23 Feb 2005 12:38:42 -0500
Greg Richards wondered: <<I work for a commercial kitchen equipment
manufacturer that is trying to get a little more professional with its
user documentation. A typical product would be a refrigerator or food
warmer. I am dazed and confused searching for relevant standards for
user documentation.>>
That's probably because there are no broadly recognized overall
standards. You may be able to find some international standards for
specific things such as warning symbols*, but I've never believed that
(for a general audience) these standards make much difference; I
strongly suspect that the clarity of the wording and of the layout is
far more important than any nominally "standard" symbols, since most
nontechnical readers don't know the standard exists and thus, may not
be familiar with it unless they read a lot of labels.
At the moment, our profession is in one of those states of evolution
where we have a wide range of supposed "best practices", only some of
which are supported by good research and only some of which are broadly
generalizable. This leaves us in the uncomfortable situation of having
to do our best to reinvent the wheel for each new type of project.
Fortunately, we have lots of wheelwrights here on techwr-l. <g>
<<The equipment is very simple to use--mostly, we are talking on/off
and some maintenance. So that's easy to cover; but I want to make sure
we comply with standards for safety and hazard cautions, warnings.>>
My recommendation is to visit your local appliance store to see what
kinds of approaches are being taken in the manuals for a range of
products. These are the kinds of approaches that consumers will be
familiar with, irrespective of whether they know of any standard.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at www.componentone.com/techwrlfeb.
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.