To index or not to index that is the question
-
WebHelpppp
- Propeller Head
- Posts: 78
- Joined: Thu Jul 17, 2014 8:08 am
To index or not to index that is the question
I am looking for some feedback regarding indexing. The last few large companies I have worked for did not include an index in their online help, the current company does. Do most companies no longer include an index in their online help and documentation? Is there a use case?
Re: To index or not to index that is the question
An index is basically a "search" for a physical printed document, and a well-produced index can be immensely useful.
However, an index isn't that useful in digital documentation like help (or viewing PDF on screen), because you will have a search. And in digital documentation, search is king.
So if you're only producing help, then I'd advise not to spend time on an index, and instead spend time on your search - e.g. review how your topic titles and descriptions work in search results, and use micro content.
Also bear in mind that with Flare's HTML5 help, an index pane is only available in the older Tripane skin, but is not available in the more recent Top Nav or Side Nav skins. So going forward, MadCap don't appear to be supporting indexes for online help.
Mind, index entries do have one handy use with help, because they're included in the search. Whilst you can set up search synonyms in Flare like "motorbike"="scooter", that only works for single words and not multiple word phrases like "motor bike"="motorbike". So if you use "motorbike" in your help text, you can add an index entry for "motor bike" to each topic which acts like an invisible keyword, and ensures that someone searching for "motor bike" will find the topic.
However, an index isn't that useful in digital documentation like help (or viewing PDF on screen), because you will have a search. And in digital documentation, search is king.
So if you're only producing help, then I'd advise not to spend time on an index, and instead spend time on your search - e.g. review how your topic titles and descriptions work in search results, and use micro content.
Also bear in mind that with Flare's HTML5 help, an index pane is only available in the older Tripane skin, but is not available in the more recent Top Nav or Side Nav skins. So going forward, MadCap don't appear to be supporting indexes for online help.
Mind, index entries do have one handy use with help, because they're included in the search. Whilst you can set up search synonyms in Flare like "motorbike"="scooter", that only works for single words and not multiple word phrases like "motor bike"="motorbike". So if you use "motorbike" in your help text, you can add an index entry for "motor bike" to each topic which acts like an invisible keyword, and ensures that someone searching for "motor bike" will find the topic.
Re: To index or not to index that is the question
Regarding indexes in Top and Side Nav, it might be possible to use the method of adding an index proxy to a topic and including that topic in the TOC, however the style for the proxy needs to be modified to allow it (and the note says "some online outputs", so your mileage may vary). See the note at the bottom of this (older) topic if you want to try it out.
https://help.madcapsoftware.com/flare20 ... ndexes.htm
https://help.madcapsoftware.com/flare20 ... ndexes.htm