Software Documentation© Janice Karin
- Lesson 3: The Importance of Word Choice and Consistent Writing
Lesson 1: What is Technical Writing?
The importance of indexing
Indexing is an important but often overlooked step in this process. Most users are going to either turn directly to your table of contents or turn directly to your index and start looking for the material they think they need. You need to make sure that information can be found from either method even if the user doesn't yet know precise terminology or an exact word to look up. Cross-indexing is an art, one that eludes many otherwise very competent technical writers. Indexing is a skill that needs to be developed and practiced regularly.
1
2
3
4
5
6
7
Print this page
|