Software Documentation© Janice Karin
- Lesson 3: The Importance of Word Choice and Consistent Writing
Lesson 6: Indexing Your Documents
Consistency in indexes
Just as it's important to be consistent throughout the text of the manual, it's also important to provide consistent index entries. If you normally capitalize all words in an index entry, make sure you capitalize them in every single entry. If you generally include three variants on each object, make sure each variant is included for each object. You'll also want to be consistent regarding which occurrences of a word or phrase to include in the index. If your chapter has a general overview that briefly discusses each major topic then later sections on that discuss those topics in detail, either index both locations for every term or don't index both for every term. Don't index some of the words in the overview and some just in the detailed sections that follow.
1
2
3
4
5
6
Print this page
|