A directory of resources inthe field of technical communication.

Articles>Indexing>Editing

18 found.

About this Site | Advanced Search | Localization | Site Maps
 

 

1.
#18554

Alphabetizing an Index

It is important to alphabetize your index in a consistent manner. Otherwise, your readers may become confused or miss an important entry. There are two basic ways to alphabetize, or sort, an index: word by word; letter by letter.

Brown, Fred. Allegro Time! (2001). Articles>Indexing>Editing

2.
#23799

Ask the Indexer: Get Answers to your Indexing Questions from Experienced Technical Indexers   (PDF)

After brief introductions by 4 panelists who are all members of the Indexing SIG (and experienced indexers and technical writers), we plan to discuss Frequently Asked Questions (FAQs) about indexing, and allow plenty of time for questions.

Bonura, Larry S., Dick Evans, Joan K. Griffitts and Peg Mauer. STC Proceedings (1999). Articles>Indexing>Technical Editing>FAQ

3.
#18542

Checking Cross-References

Before publishing your index, you need to ensure that the 'See' and 'See also' cross-references work correctly. The text in each cross-reference must exactly match the text in the index heading it refers to.

Brown, Fred. Allegro Time! (2002). Articles>Indexing>Editing

4.
#31098

Developing Indexes

As a technical writer, you'll typically have to create indexes for the print books and for online helps you develop. The type of index we mean here is the classic back-of-book index that shows page numbers on which topics and subtopics occur within the book. An online index is much the same except that you supply hypertext links rather than page numbers.

McMurrey, David A. Illuminati Online (2004). Articles>Editing>Indexing>Technical Writing

5.
#20345

Edit Your Index: A Checklist for Efficient Editing   (PDF)

This session presents a checklist for editing an index. Discussion will focus on the most efficient means of repairing straightforward index problems as identified in the checklist, such repairs being made either by the compiler of the index or by a project editor. In cases where an index cannot be fixed (so that the editor must make the decision to start over), the checklist is an objective reference for making that difficult decision.

Cohen, Barbara E. STC Proceedings (1999). Articles>Indexing>Editing

6.
#15122

Editing an Index   (PDF)

Collins and Hamilton's thorough guide to editing indexes offers tips on the most difficult and time-consuming of indexers' tasks.

Collins, William L. and Karen J. Hamilton. Intercom (2001). Articles>Indexing>Editing

7.
#10810

Editing Indexes

Like any well-written document, an index needs to be edited. Editing ensures consistency, clarity, completeness and accuracy. And an effective index contributes substantially to the usability of a document.

Brown, Fred. Allegro Time! (1999). Articles>Indexing>Editing

8.
#18541

Finding Information in Different Ways

People think about questions or information in different ways. It’s important for an index to provide multiple ways of locating any given piece of information.

Brown, Fred. Allegro Time! (2003). Articles>Indexing>Editing

9.
#18306

Gathering Together

An index pulls together all the references to a topic that are scattered within a publication. If a reference is omitted, the user may assume that particular sub-topic is not discussed.

Brown, Fred. Allegro Time! (2002). Articles>Indexing>Editing

10.
#30508

Indexing Standards and Usability Tests   (PDF)

This paper provides reference information and complements the demonstration: 'Using Indexing Standards and Usability Tests' by Deborah Swain and Rebecca Oliver. Information covered in the paper includes historical background on indexing and on the ANSI Z39.4 standard for indexes. Questions about the effectiveness of standards are discussed. In addition, the paper describes one way to conduct a usability test on a back-of-the-book index: random analysis. (Three testing methods will be explained in the demonstration.)

Swain, Deborah E. STC Proceedings (1993). Articles>Editing>Indexing>Usability

11.
#21380

Indexing Technical Documents

If a document contains the information that a reader needs, but if the reader cannot find that information, then the document is useless. Worse than useless, it’s a hindrance. If I know that some information is not available, I won’t waste my time looking for it. However, if I think the information is available, and if I can’t find it after a period of fruitless searching, all I will have achieved is frustration.

Mike Unwalla. TechScribe (2004). Articles>Indexing>Technical Editing

12.
#26025

Indexing Technical Documents: An Interview with Lori Lathrop

Indexes are as important to your documentation as your documentation is to the product. Just as it would be difficult, if not impossible, for people to use your product without any documentation, it is equally difficult for people to use documentation without a good index.

Vega, Barbara. Writing World (2001). Articles>Indexing>Technical Editing

13.
#20192

Indexing Workshop   (PDF)

Although we all agree on the importance of a good index, many technical writers find themselves in the position of having to produce an index in a short amount of time with no training or experience.

Winsberg, Freya Y. STC Proceedings (1997). Articles>Indexing>Editing

14.
#19973

The Joy of Indexing: How to Make a Good Document Better   (PDF)

An index is a road map for a document. A good index helps the user find information easily and quickly. It anticipates the user’s needs and provides logical headings and a parallel, consistent structure. Creating an index involves five steps: 1) analyzing the audience; 2) determining the physical appearance and standards of the index; 3) reading and marking the text; 4) producing, editing, and proofing the index; and 5) testing the index for clarity and usability and revising it as necessary.

Gyure, Gloria M.D. and Colleen S. Kelley. STC Proceedings (1996). Articles>Indexing>Editing

15.
#30339

The Role of Indexing in Technical Communication

The success of a technical document depends heavily on the index. The task of indexing a technical document often cannot begin until insufficient time remains to do a good job. However, for many users of the document, a good index is mandatory to its usability.

Northrop, Mary Jane. Boston Broadside (1993). Articles>Editing>Indexing

16.
#18556

'See also' Cross-References

'See also' cross-references assist the user to quickly navigate to the right index term. The same principles that apply to 'See also' cross-references apply equally to hypertext linking. 'See also' cross-references are constructed using the following relationships: a broader term to a narrower term, e.g. 'mammals, See also whales'; sailing craft, See also hulls overlapping meaning between two terms, e.g. 'gold, See also money'

Brown, Fred. Allegro Time! (2000). Articles>Indexing>Editing

17.
#20136

Six Steps to Producing an Index   (PDF)

If something does not appear in the index, it might as well not be in the book because the reader may never find it. Writing a complete index takes time and patience. Writing an index that is consistent and effective requires refinement and common sense. Here are six steps that will get you through the process.

Winsberg, Freya Y. STC Proceedings (1996). Articles>Indexing>Editing

18.
#32684

Quick, Quality Indexing for Environmental, Safety, and Health

Indexing for environmental, safety, and health texts, you provide sure, quick access to critical information in times of need.

Wyman, Pilar. STC Proceedings (2008). Articles>Editing>Indexing>Policies and Procedures

There are 16 readers currently online: 3 registered users and 13 guests. Register.Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon