Why an Index?"By far, the index is considered to be the most important software documentation support feature." — conclusions of a survey by the Dataquest Desktop Software Support group (1993).
The index acts as a "quick reference" tool. Its goal is to find 80% of the information, 80% of the time. The index provides the user with a well-known and reliable tool for finding key information quickly.
Users need indexes in
An index helps the user by
Keys to successA glossary will help ensure consistent terminology within the documentation and in any computer application screens. In turn, consistent use of terminology will assist the indexer to create an effective index. Note that an index is constructed based on topics, concepts, and user tasks — not the simple occurrence of specific words.
To work effectively, an index must be written by a person with professional indexing skills — a poor index will only frustrate the user further.
An effective index
Online accessIndexes work together with hypertext links, full-text searching, natural language searching and metadata (e.g. the Keywords Meta tag in HTML) to provide a range of search options. For example, a user may begin by using the index to quickly find key information. Using words from the results of this initial search, the user may then do a full-text search to find other discussions. And hypertext links lead to related examples.
The vital linkThe index, more than any other tool, links your user together with your information. A good index will help
Allegro Technical Indexing