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 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 -

Geoff Hart wrote:
> 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.

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!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:

Re: A reminder: visual and other indexes: From: Craig Haiss
A reminder: visual and other indexes (take II): From: Geoff Hart

Previous by Author: Re: A reminder: visual and other indexes
Next by Author: Re: Screen captures and sizing
Previous by Thread: A reminder: visual and other indexes (take II)
Next by Thread: Re: A reminder: visual and other indexes

What this post helpful? Share it with friends and colleagues:

Sponsored Ads