Home > Using RoboHelp > Indexes > Index guidelines
Put users first A good online index focuses on its users – their tasks and their way of thinking. Consider your users' backgrounds and knowledge. Use words and phrases they're likely to think of when looking for information. Users can and do form impressions about the usefulness and value of a Help file based on their experience with the index – and in this case, perception is reality. If they can't locate information in the index, users may doubt whether or not the information exists in the Help file. If users are consistently taken to the wrong topics or to unexpected topics, they may doubt the accuracy of the Help file.
Index the most important words Make the most of your allotted indexing time by including only those words and phrases your users are most likely to look up. You don't have to index every possible word or phrase – like "About" or "Working with." For ideas on good index entries, look at the features and content of your Help system – topic titles, headings, tables, examples, and so on. Include terms commonly used by both beginners and experts.
Provide multiple ways to access the same information Users may not be familiar with the terms and concepts used in your Help system – by providing them with synonyms and alternate index entries, you can lead them to the right information. Include verbs, noun phrases, and synonyms to reach the widest range of users. Remember to index your competitors' terms, too – users may not know the name of the feature in your Help system, but they might know what it's called in your competitors system.
Use consistent access routes Keep the phrasing and approach consistent throughout the index. Include inverted terms and headings – what the command is as well as what the command does. This approach helps users find information regardless of whether they're looking for the command or the action the command accomplishes. (For example, X-Rays:Viewing, Viewing:X-Rays.)
Provide enough detail for users to choose Provide enough description with your index entries so users can determine which path to choose. Users should be able to tell the difference between index entries that lead them to conceptual overviews and entries that lead them to tasks.