Getting in the Last Word - Part Two - Index

The index is one of the most important sections of the manual. Don’t forget it. Most of all, don’t skimp. This section will probably be your reader’s first exposure to your writing. 

Do arrange indexes alphabetically.

Getting fancy with an index only complicates matters. Your readers want a basic index that they can use to look up information. Don’t make them work for it. Help your reader by making your index easy to use.

Don’t copy the Table of Contents into your Index.

If your reader wanted to reference the table of contents, they’d go to the front of the manual. Give your reader real, valuable reference material in the index.

Do remember to index acronyms.

Reference the acronym by the complete spelled out version as well as the shortened acronym.

Don’t index concepts.

Be accurate and precise. Give the readers tangible information by being specific when using phrases in your index. Make sure the exact text phrase is used in the index and can be easily identified in the referenced text.

Do use the popular “see also.”

This helps the reader find closely related material. Don’t forget it.

Don’t forget to cross reference.

This is important because not every reader is the same. Some people may look for the section about editing files under “editing files” while others will look under “Files: Edit.” Don’t keep your readers guessing how to find information. Put it in several places by cross-referencing.

Do use headings.

The best indexes are multi-level. It gives the reader as much reference material as possible. Remember, your reader’s needs come first.

Do let those who are closest to the users/readers review the index – Customer service and technical support. They’ll understand what your readers will be looking for more than anyone else.

Last but not least, we'll look at the Frequently Asked Questions section.

Go To Page: 1