Learning to index my own project

Subject: Learning to index my own project
From: "Jennifer C. Bennett" <fritillary -at- gmail -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 10 Dec 2008 12:33:49 -0600


I am a technical writer working in the software industry. I've been working
on a large RoboHelp 7 Web Help project. I really need to create an index
for this project - but I want to go about it the right way, and I'm not sure
where to begin. I don't trust the RoboHelp "Smart Index" feature for
creating an index. It might be more useful for a smaller project. Since
the project is so large, I am tending to think that the index should be well
thought out, rather than relying on an automated system.

I've looked up a couple books on Amazon - does anyone have any insight as to
whether these books would be useful for someone who is indexing her own
WebHelp projects? My goal is simply to make the information in the WebHelp
project (which is also compiled into DOC and PDF files) as easy as possible
for my users to locate.

* Can I create an excellent index from scratch using "Indexes: A Chapter
from the Chicago Manual of Style"? (nice price!)

Or should I purchase a book that is more in-depth on the subject - or would
that be overkill? The books I've been looking at include:
* "Indexing Books" by Nancy C. Mulvany (As mentioned in the title, this
book is for indexing *books* - does the information translate to indexing
for WebHelp?)
* "The Indexing Companion" by Glenda Browne and Jon Jermey

Any other suggestions?




ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:


Previous by Author: Re: What about OLD computers??
Next by Author: Re: Onsite or on-site?
Previous by Thread: The importance of technical writing
Next by Thread: Re: Learning to index my own project

What this post helpful? Share it with friends and colleagues:

Sponsored Ads