Re: query re help

Subject: Re: query re help
From: David Neeley <dbneeley -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sat, 27 Nov 2004 15:02:08 -0600

In my experience, the most significant failure of documentation
(online and printed) is the frequent omission of a really good index.

Too often, you must know the application's use of specialized
vocabulary, with no indexed synonyms--especially the most commonly
found ones--to lead you to the answers you seek.

It is definitely not for nothing that indexing is a bit of an art unto
itself, and that good nonfiction books outside of the computer field
often employ professional indexers. Occasionally, the best computer
books do too--but I personally cannot recall any documentation that
has used such an indexer.

Another method I rarely observe is to have a thorough collection of
tech support questions, paying particular attention to the users and
the questions they ask. That way, a fairly good topic list can be
developed for use in the index.




RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo:

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

RE: query re help: From: Karen L. Zorn

Previous by Author: Re: Document Distribution
Next by Author: Re: The state of State
Previous by Thread: RE: query re help
Next by Thread: Re: query re help

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

Sponsored Ads