Value of Indexes in Short User Guides

Subject: Value of Indexes in Short User Guides
From: Eddie Hollon <eddiehollon -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 21 Feb 2007 21:05:58 -0800 (PST)

Can those of you with experience producing short user guides (e.g., 50-60 page guides for mobile phones) share your opinions on the value of indexes in these documents? I am currently writing style guidelines and am very interested in what other TWs have to say. Many competitor's documents do not include indexes, but I am still in favor of providing the user with an index as a quick means of searching for topics. I would appreciate any and all opinions on the general debate (to index or not to index?) as well as more specific issues, such as levels of detail and whether a noun/noun phrase or topic/action/condition strategy is more useful to readers.

Many thanks in advance,

Eddie Hollon
Suwon, South Korea

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


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
http://www.techwr-l.com/techwhirl/ for more resources and info.


Follow-Ups:

Previous by Author: Re: Opening TIFFs from a Browser
Next by Author: Re: Value of Indexes in Short User Guides
Previous by Thread: RE: Protecting Parts of Documents in Word
Next by Thread: RE: Value of Indexes in Short User Guides


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


Sponsored Ads