Re: Indexes and PDF Files

[Joanne Sprott <afterwords -at- aweditorial -dot- com>]

Just a note from a professional indexer and editor looking at the 
shifting sands of information access in the high-tech world:

The full text search of PDF docs has its pros and cons. Like a search 
engine, it brings up every instance of a term mechanically, whether it's 
really relevant to your search or not (main discussion plus incidental 
mentions in individual procedures, etc.). It works, but it lacks any 
intelligence and doesn't weed out anything trivial for you. But if your 
docs are not going to the general public and everyone is familiar with 
the vocabulary of your technology, it may be cost/time effective to 
ignore indexing. The bookmarking method seems to have more merit, 
although humans do tend to find it more intuitive to scan an 
alphabetized list. The bookmarks are basically a redo of the TOC, right? 
A lot depends on the length and complexity of the doc itself as to 
whether a hierarchical organization of material will be easy to scan.

For print manuals, particularly for devices used by novices (personal 
computers, cell phones, etc.), indexes created by competent humans seem 
to be valuable from my experience so far. One user study says one thing, 
another another thing. One cell phone manufacturer looked us up 
specifically for training on term selection and index structuring for 
their user guide writers because their usability study said that over 
50% of their users use the index to find stuff. As Mayur pointed out 
about synonyms and such, novice users also often come to a doc with a 
vocabulary that doesn't match that of the insiders who wrote it, so 
double-posting and cross-referencing in an index would be of value to them.

So, the value of human-created indexes seems to depend on the content 
and structure of your material, and most importantly, your audience. 
Unfortunately, the embedded indexing tools in most software used for 
technical writing are not made to help the writers create quality 
indexes in an efficient manner, so, with the short deadlines I've seen 
in the tech doc world, indexing ends up getting short shrift anyway. And 
so the technical support people get more calls. That seems to be the way 
it goes with consumer products anyway.

Joanne

AfterWords Editorial Services
Joanne Sprott and Sue Gaines
713-252-1945
PMB 113
9597 Jones Road
Houston, Texas 77065
joanne -at- aweditorial -dot- com <mailto:joanne -at- aweditorial -dot- com>
sue -at- aweditorial -dot- com <mailto:sue -at- aweditorial -dot- com>
http://www.aweditorial.com




PRASANNA PRABHU wrote: