RE: Indices and not-indices

Subject: RE: Indices and not-indices
From: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
To: "Julie Stickler" <jstickler -at- gmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 23 Jul 2008 09:58:34 -0400

Julie Stickler noted:
> Indexing doesn't need to take a lot of time. When I wrote my first
> manual (which weighed in at about 400 pages) I spent two days building
> and tweaking the index. And it doesn't have to be perfect right away.
> I plan two or three days for indexing a project, be it a manual or a
> help system. I usually do my indexing during that couple of days
> when the docs are out for review and I'm waiting for edits and
> comments to come back.

I didn't quite know what to make of that remark. Then I realized: two
different worlds...

In the days when my docs for a product release are out for review, I'm
doing the docs for a couple of other products that are at different
points in their schedules, planning the next several near-term release
schedules (the document part thereof), and attending various meetings.

I do what I can, when I can, to ensure that the index is more than just
a concordance, but I remember the "old days" when I actually worked for
days (here and there) to make a document's index:
a) large
b) comprehensive
c) useful.

I wonder how many Whirlers have actual planned gaps in projects where
they aren't working on different stages of several other projects,
simultaneously or in tightly interleaved fashion.

- Kevin

The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.


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.

Indices and not-indices: From: Kevin Elmore
Re: Indices and not-indices: From: Jay Maechtlen
Re: Indices and not-indices: From: Julie Stickler

Previous by Author: RE: Workplace issues
Next by Author: RE: workplace issues
Previous by Thread: Re: Indices and not-indices
Next by Thread: A Career in Technical Writing: Life as a newbie

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

Sponsored Ads