B O O K S

Indexing: A Nuts-and-Bolts Guide for Technical Writers

by Kurt Ament

Overview | Contents | Reviews | Order

This guide explains in plain language and by example exactly how to index any type of print or online documentation quickly, easily, and effectively.

Chapter 1. About indexing

Summary:

This chapter introduces the sequential indexing method. A structural overview of products, product documentation, and document indexes explains why the sequential indexing method is so successful.

Sections:

Anyone can index

Indexers are made, not born

Indexing does not have to be painful

Nothing succeeds like success

Sequential indexing

Separating content from format

Keeping your sanity

Usable indexes increase profits

Usable indexes improve documentation

Usable documentation improves products

Usable products sell

Chapter 2. Start indexing

Summary:

This chapter contains sequential step-by-step procedures. These procedures explain exactly how to index any type of document, from start to finish. Each procedure step contains cross-references to detailed indexing guidelines in Chapter 3, "Indexing guidelines."

Sections:

1. Index chapters
2. Index procedures
3. Index topics
4. Index product names
5. Index product components
6. Index front and back matter
7. Edit your index
8. Create "see" references
9. Create "see also" references
10. Test your index

Chapter 3. Indexing guidelines

Summary:

This chapter contains detailed indexing guidelines. These guidelines explain everything from indexing acronyms to creating "see also" references to building master indexes. The guidelines are sorted alphabetically for easy reference. Each guideline contains positive and negative examples as well as cross-references to related guidelines and procedures.

Sections:

Abbreviations

Acronyms

Articles

Back matter

Capitalization

Cross-references

Front matter

Interface components

Keyboard shortcuts

Master indexing

Nesting

Page ranges

Prepositions

Procedures

Product names

Scheduling

"See" references

"See also" references

Sorting

System messages

Tools

Topics

Index

The guide practices what it preaches. It is fully indexed, following its own guidelines.