Onsite Indexing Basic Skills
Technical Writing Teams
present a training workshop tailored to your documentation
your needs. The workshop follows the indexing principles laid
out in ISO 999: Information
and documentation —
for the content, organization and presentation of indexes.
staff will learn
in Adobe FrameMaker, Microsoft Word, DocBook XML or DITA
your own indexes
- apply indexing principles
in variety of contexts including web sites and intranets
workshop takes a hands-on,
practical approach to indexing technical documents. In the
you'll work with indexes in both paper and electronic formats. You'll
indexing principles and practical tips.
workshop consists of seven modules:
begin by doing
tests on a number of popular "how to" books. Participants learn that
are many not-so-helpful indexes out there. We establish the key
characteristics of successful indexes.
edit a sample
index during which we learn the basic principles of indexing and how
are applied. At the end of this exercise, many participants have
I never understood how to edit an index. Now I do."
try our hand at writing
an index using file cards. Participants are able to sort
as they write — and the index appears before their eyes.
possibly one that you choose, we learn how to code index
markers. Tricky issues such as "See" and
cross-references and how to enter page ranges are examined. Finally, we
to edit the index markers to produce the final index.
Hierarchical and related term relationships
learn to identify hierarchical and
related term relationships, and examine how to represent these
relationships in an index.
6. Quality criteria for indexes
learning by examining five
quality criteria in a variety of contexts, both print and
7. Evaluate the team's own published indexes
the strengths and weaknesses of their own work to date. The
develops a common agenda for improving their indexing.
working in related areas
such as user interface engineering, web or intranet design,
and translation, may wish
to join the documentation team for modules 1, 5 or 6.
professional indexing competence. Your technical writing team
- A two-day
for up to 16 people
at your site
on indexing technical documentation
- Evaluation of three major indexes
following the course
support for your
indexing questions — for one year
Workshops for Technical
Writers [PDF 63 KB], published in The
2003, the Society of Indexers.
Brown brings over ten years technical writing and indexing experience.
He has given
workshops on technical indexing to the Society for Technical
(STC) and to SIGDOC.
worked with Nortel
DY 4 Systems, TimeStep Corporation and other high-technology firms in
details of Fred's
samples of Fred's
indexing work, click
be able to create professional indexes for your documentation. Allegro
will provide ongoing free telephone and email support for one year.
in the U.S.A. and Canada is 5,000 USD plus travel expenses. For other
locations and non-native English language speakers, please contact Allegro Technical Indexing.
your needs and obtain a quote, contact Fred
Course for Individual Technical Writers and Small Groups
This course is ideal for individual technical writers or small groups seeking cost-effective training on a timely basis.
Delivered by email
this hands-on course covers much of the same material as the onsite
basic indexing skills workshop for technical writing teams. You will
learn how to create effective indexes for
technical documents. The course covers:
package also includes creating a major index a complete document. Email support continues for one year.
- creating index entries
- embedding index entries in Adobe FrameMaker,
Microsoft Word, DocBook XML or DITA
Fee: 800 USD for one participant and 400 USD for each additional participant. For further information contact Fred
Home | Website indexing | Training
expertise | Articles
your index | Sample
indexes | Internet resources | Contact
~ Top ~