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.
Visuals in work instructions: how many is too much?
Subject:Visuals in work instructions: how many is too much? From:Geoff Hart <ghart -at- videotron -dot- ca> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>, "Ahles, Wesley Christopher" <wesley -dot- ahles -at- mnsu -dot- edu> Date:Mon, 04 Jun 2007 17:01:31 -0400
Wesley Christopher Ahles wondered: <<A question for anyone who has
made work instructions, or who may just have an opinion.>>
Sorry, you won't find many opinions here. <gdr>
<<I'm writing some assembly work instruction. The rough draft is just
over a page, with 11 steps. Right now, I have 6 visuals in mind. Is
this too many, or is there no real rule for this sort of thing?>>
There's an inviolable rule for anything, dontcha know! <g> In this
case, the only good rule is that there's no good rule -- or at least
no rule that specifies the "correct" number. The appropriate number
of visuals is determined using a simple rule of thumb: if you can't
describe something clearly and precisely using words, or if you're
describing something whose primary characteristics are visual (rather
than textual), use an image. If text communicates the same concept
more clearly and precisely (and concisely), use text.
Note that if you're planning on internationalizing your instructions,
there's some merit to emphasizing images over text: there is less
translation to do and less risk of miscommunication if the images
work clearly. Hewlett-Packard does some nice work in this area with
their installation and setup instructions.
----------------------------------------------------
-- Geoff Hart
ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
www.geoff-hart.com
--------------------------------------------------
***Now available*** _Effective onscreen editing_
(http://www.geoff-hart.com/home/onscreen-book.htm)
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-