RE: Indexing of reference manual?

Subject: RE: Indexing of reference manual?
From: Marguerite Krupp <mkrupp -at- cisco -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 18 Oct 2001 09:19:52 -0400

If you index the body of the manual (but not the commands) in the Index, but
you let the TOC carry the weight for the commands, you are, IMHO, doing the
readers a disservice by making them look in two different places for
information. This adds to the frustration factor. Don't fall for the old
cop-out that "users will figure it out."

Even if the commands are listed and described alphabetically in the book
*and* in the TOC, I would also expect them to be listed in the Index. That
also gives you, the author, the chance to add appropriate cross-references,
as other posters have mentioned. It adds value by allowing another search


Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

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: Not only writing skills...
Next by Author: RE: XML as Help Format
Previous by Thread: Re: Indexing of reference manual?
Next by Thread: what's *.dat?

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

Sponsored Ads