Re: Indexing gui elements

Subject: Re: Indexing gui elements
From: Dick Margulis <margulis -at- fiam -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 18 Dec 2003 06:46:10 -0500

If you must document each gui element, use tables in an appendix, one table per screen/page, divided into sections (fields, buttons, etc.), with a text description or instruction for use for each element. In most cases this is serious overkill, but if your audience is such or your application is such that you need to document to this level of detail, this is by far preferable to indexing.

rk5jeeper -at- hotmail -dot- com wrote:

Does anyone have any opinions on indexing gui elements. My group is in the
middle of a debate about including each field, button, etc. in our index.
Some claim users use the index to look up fields. Others think it buries
the real information in our user guides. Unfortunately we have not done a
survey to find out. But I am curious to see if others do index field
names. Our documentation architecture has all gui elements in the various
forms and dialog box separated from our process documentation. I can't
remember any software manuals I have ever looked at that include and index
entry for every field. What say you all?

[This E-mail scanned for viruses at]



RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web. The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for competitive pricing or download a trial at:

You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.


Previous by Author: Re: What's the definition of a published author
Next by Author: Re: Preparing a bid
Previous by Thread: Indexing gui elements
Next by Thread: Re: Indexing gui elements

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

Sponsored Ads