Re: A reminder: visual and other indexes

Subject: Re: A reminder: visual and other indexes
From: Craig Haiss <craighaiss -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 11 May 2009 07:22:26 -0700 (PDT)

Perhaps the clutter of UI information can be reduced by grouping all such content into a single chapter of the documentation. If the chapter is clearly introduced in the opening paragraph and table of contents, users can simply skip it if they aren't interested.

In help, clutter isn't really an issue. Users only see what they click on. One clearly-worded link in the TOC would give UI information a high profile for people who seek it, while at the same time avoiding clutter.

Craig Haiss

--- On Sat, 5/9/09, Robert Lauriston <robert -at- lauriston -dot- com> wrote:

> From: Robert Lauriston <robert -at- lauriston -dot- com>
> Subject: Re: A reminder: visual and other indexes
> To: "TECHWR-L Writing" <techwr-l -at- lists -dot- techwr-l -dot- com>
> Date: Saturday, May 9, 2009, 1:00 PM
> Yeah, it's very annoying when docs don't tell you
> how to navigate to
> the command / dialog being discussed, but screenshots of
> menus just
> clutter up the doc and waste the writer's time.
> My negative attitude about that sort of thing was probably
> exacerbated
> by having inherited so many docs that contained nothing but
> a useless
> narrative of the UI.


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: Robert Lauriston

Previous by Author: RE: Shazam! You're a marketing writer!
Next by Author: RE: fantastic tool for TW: Wolfram alpha screencast
Previous by Thread: Re: A reminder: visual and other indexes
Next by Thread: A reminder: visual and other indexes (take II)

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

Sponsored Ads