TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Aside from 'spotting gotchas' that others have mentioned, I've put
indexing to very good use in the past for *targeted reviews of changes*.
For instance, if a "User Story 123456" resulted in my changing 15
topics, then I would add an index entry like so:
123456 25, 28, 30-32, 50, 256
Alternately, if I had another driver of change, like a specific
developer's design document or a feature name, Id use:
<indexterm>!Feature<indexterm>Fooing bars for
The result being that I could put out an Adobe Shared Review PDF for a
whole team, for weeks of development, and they could quickly jump
through the additions and changes using all (and only) the index entries
that pertain to them.
Then just comment out the 'review-tracking' index entries after approval
(and remove any change highlighting--the index helps *me* find those
later!) and they no longer appear... BUT, I still have, in the working,
source files themselves, searchable unique strings if I ever have to
lookup what caused me to change what, when.
Kinda powerful, if you don't already have other significant
change-tracking controls (CMS history, dev-item-tracking app, etc). And
even if you DO, you can 'audit' in just your file stack, using search:
no need for complex queries in other tools and correlating their results
to your file stack. One Stop Shop, so to speak. :-)
Can you elaborate on how indexing is a good way to review your work?
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com