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.
> I know this study -- possibly flawed, certainly old -- doesn't say
what
> we all think to be true in our infinite conventional wisdom. But we
> either commission a new study, or we work with what we've got. Upon
> meeting studies that don't make us happy, we can fight them, or we can
> think about ways to use the information.
Or we can use our judgment and arrive at any of a number of other
conclusions, such as: the study is too flawed to trust its findings, or
the testing scenarios aren't relevant to what I'm doing, or the test
subjects aren't representative of my audience, or... I don't _have_ to
do a new study or accept the old one -- doing _neither_ is a completely
reasonable choice, IMHO.
Tom Johnson wrote:
> supposed to click. For example, if I wrote "Click the Print button,"
I'd
> have a line extending from the word Print to the actual Print button
in a
> full screenshot.
Why? Does your audience needs to be shown a Print button in order to
understand your instruction? Is the user interface a crowded, jumbled
mess where command buttons are randomly scattered about and hard to
find? Or is there some other reason?
I'm confident that if I write "Click the Print button," my audience will
understand me and will have no trouble finding the Print button in the
reasonably well-designed and consistent interface. So why do I need a
picture with circles and arrows?
Everything involves trade-offs:
-- If I spend X hours lovingly massaging scores of screenshots that add
little or no value for my audience, I'm not spending that time doing
something more valuable.
-- If I turn an 80-page manual into a 200-page manual by catering to the
3-5% of the audience that needs plenty of reassuring pictures and lots
of hand-holding, maybe 20-30% of the audience gets turned off by the
sheer bulk and/or the boring and tediously simplistic content.
Don't try to please everyone or make everything of equal importance --
you'll please no one and do everything poorly.
Richard
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
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-