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: User documentation - drawings or photographs? From:"Paul Goble" <pgcommunication -at- gmail -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 22 Jan 2008 11:46:19 -0700
Sylvia asked:
> So, what is the recommendation? Drawings or Photographs and why?
I've been using more photos, too. The user-centered
considerations--which have already been discussed--can interact with
other business considerations. It's rare that unlimited resources are
available to create nice drawings. Given a fixed time budget, I can
include 20 photos or 3 illustrations. Photos give me flexibility to
finish the manual sooner, release the product, and move on to
something else.
Photos are good for complex mechanical tasks, such as showing how to
hold a tool or how to push loose cables out of the way. (GOOD
illustrations might be better, but drawing fingers is tough, and it's
easy to over-simplify and miss the fact that the "virtual" hand is
touching that razor-sharp piece of sheet metal.)
I've heard it argued that one should stick with either photos or
drawings throughout a given set of documentation. Consistency
certainly lends to a more professional look. But for real users, I'd
argue that "professional appearance" is a third-order psychological
effect. Usefulness (or even just adequacy) is much more important.
So go ahead and mix them, within reason.
--
Paul Goble
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
