RE: Testing an index

Subject: RE: Testing an index
From: "Marguerite Krupp (mkrupp)" <mkrupp -at- cisco -dot- com>
To: "Wanda Phillips" <wanda -dot- jane -at- gmail -dot- com>
Date: Mon, 25 Feb 2008 15:39:58 -0500

Wanda asked: "How do the see and see also entries work out in an online
index? I think we were having trouble with them, though I cannot recall
the details."

We're using FrameMaker 7.2 to create more-or-less traditional books that
users usually access either as HTML or pdf, so the indexes we generate
are the same for both print and online. All of our Index entries are hot
links online. And yes, it can take a lot of time. Our "See" and "See
also" entries are not extensive, but at least we do have a few for key

We also create and index online help (single-sourcing as much as
possible), and we generate a separate, traditional html/pdf book from
that help, too. Same story for this book index.

With that preamble, the online indexes seem to work out pretty well with
the "See" and "See also" entries. A user can go directly to the Index of
a document to look up a term, but s/he can also find the term using a
synonym/related topic in the Index by using a full-text search, then
following the link to the base term. So I think that these constructs
remain a good idea, online of off.


-----Original Message-----
From: Wanda Phillips [mailto:wanda -dot- jane -at- gmail -dot- com]
Sent: Monday, February 25, 2008 12:19 PM
To: Marguerite Krupp (mkrupp)
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Testing an index

We are not, currently, using alternate terminology to point to our
content (ultrasound equipment), though I used to it with the data
management software I used to document. Part of our issue has to do with
the time required to build the word lists. Maybe once we get a handle on
DITA and if it produces even a tenth the efficiencies we're promised...
well, maybe then we can start expanding our index in that direction.

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

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

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 for more resources and info.

RE: Testing an index: From: Marguerite Krupp (mkrupp)
Re: Testing an index: From: Wanda Phillips

Previous by Author: RE: Testing an index
Next by Author: how do you indicate blinking lights?
Previous by Thread: Re: Testing an index
Next by Thread: Re: Michael Bremer's "UnTechnical Writing" book

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

Sponsored Ads