An index is an alphabetical list of all the major topics and somtimes sub-topics discussed in a piece of technical writing. An index cites where each topic can be found and allows readers to find information on particular topics quickly and easily. The index always comes at the very end of the work.
They key to compiling a good index is selectivity. Instead of listing every possible reference to a topic, select references to passages where the topic is discussed in depth. For the index entries, select those words or phrases that best represent a topic. Key terms are those that a reader would most likely look for in an index. For index entries on tables and illustrations, use the key words in their titles.
Compiling an Index
Building an index should always be postponed until the final manuscript of the work is completed because pafe numbering will not be accurate before then.The best way to compile a list of topics is to read through your written work from the beginning and each time a key term appears in a significant context, list the term and its page on a 3x5 index card. Below is a sample index entry with entries, sub-entries and sub-sub entries:
Wording Index Entries
The first word of an index entry should be the principal word, because a reader will look for topics alphabetically by their main words. Selecting the right keyword can be tricky. For instance, an entry with two keywords, like electrical wire, should be indexed under each word (electrical wire and wire, electrical). Index entries should be written as nouns or a noun phrase rather than as an adjective alone.
in an index help readers find other related topics in the text. Cross
references do not include page numbers; they merely direct readers to
anothe index entry, where they can find page numbers. There are two kinds
of cross-references: see references and see also references.
See also references indicate othe entries that include additional information on a topic.
Back to Technical Writing Homepage | Webmaster