Software Documentation


© Janice Karin

Lesson 6: Indexing Your Documents

Choosing which instances to mark

The words "error handling" might appear three times in every paragraph within the error handling section. You don't want to include separate index entries for each instance - that would be overkill and lead to a cluttered, difficult-to-use index. If your indexing supports page ranges, you could decide to include the entire range of the chapter within a single index entry. If your index only allows single page entries, then you'll need to determine if marking the first page of the section is sufficient or if you need further markers at important points within the section.

Perhaps a more complex situation is when you discuss a concept in a chapter overview and then provide full details a page or two later within the chapter. You'll need to decide whether it makes sense to index both places or just the area where you provide the detail. This is your choice, and you'll need to decide what makes sense for your book.



Previous Page  1  2  3  4  5  6   Next Page

Print this Page Print this page