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.
RE: Visuals in work instructions: how many is too much?
Subject:RE: Visuals in work instructions: how many is too much? From:"Sharon Burton" <sharon -at- anthrobytes -dot- com> To:"Jim Morgan" <Jim -dot- Morgan -at- jdsu -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 5 Jun 2007 16:04:34 -0700
Considering that most tech writers are word oriented learners, making
documents with lots of words pleases us. But we're not our audience.
If your audience are visual learners, then you need lots of pictures AND
words. Not just if "the text cannot make the action clear". Visual learners
will go to the picture to make the action clear and then give up. They won't
look at the words, regardless of how well crafted they may be.
-----Original Message-----
From: techwr-l-bounces+sharon=anthrobytes -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+sharon=anthrobytes -dot- com -at- lists -dot- techwr-l -dot- com]On
Behalf Of Jim Morgan
Sent: Tuesday, June 05, 2007 1:19 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Visuals in work instructions: how many is too much?
Wes wondered:
"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?"
But for most audiences and uses, I think putting in too many visuals
slows down reading speed without added benefit. (In print, anyway: In
hypertexts, this problem is easily solved by providing links to
nonessential visuals, instead of embedding the visuals in the text.) My
practice has been to include visuals if, as one of the other replies
noted, the text cannot make the action clear. For example, in user help
I don't say "Result: The Blah Window opens," and then include a shot of
the Blah window. They can see that onscreen. But if they have to turn
off some options and turn on others, I will include a shot of the Blah
window as it should appear when the user is done with those actions.
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-