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: A reminder: visual and other indexes (take II)
Subject:Re: A reminder: visual and other indexes (take II) From:Mike Starr <mike -at- writestarr -dot- com> To:TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 11 May 2009 09:57:10 -0500
If the only access to the visual information you describe is in a separate chapter, then yes, we'd be interrupting the user's flow by diverting them to a chunk of reference documentation. However, I'd suggest we'd serve the users better by having *both* that chapter of visual information as reference documentation and incorporating sufficient visual information into the procedural documentation.
Mike
--
Mike Starr WriteStarr Information Services
Technical Writer - Online Help Developer - Technical Illustrator
Graphic Designer - Desktop Publisher - MS Office Expert
(262) 694-1028 - mike -at- writestarr -dot- com - http://www.writestarr.com
Geoff Hart wrote:
<snip>
> But where possible, we should also avoid "taking users out of their
> task", which is to figure out how to use a feature. The problem with
> placing visual information in a separate chapter or index is that we
> make users stop what they're doing (following the steps of a
> procedure) and go searching elsewhere for the visual details. That's
> not necessary nor is it kind. This is why I stated "give me a picture"
> for things like icons; it's easy to do. If I see the image right
> beside the step I'm trying to figure out, I don't have to go look it
> up somewhere.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-