A directory of resources inthe field of technical communication.


120 found. Page 1 of 5.

About this Site | Advanced Search | Localization | Site Maps

1 2 3 4 5  NEXT PAGE »



A-Z Indexes to Enhance Site Searching

On a Web site or intranet each of the alphabetically arranged entries or subentries is hyperlinked to the page or to an anchor within a page to where the topic is discussed. Since an alphabetical index can be quite long, it is often divided into pages for each letter of the alphabet. Typically, each letter is linked at the top of the page allow a jump to the start of that letter’s section of the index.

Digital Web Magazine (2005). Articles>Web Design>Indexing>Information Design


Advice for Editors and Authors  (link broken)

A page of online resources for editors and indexers.

ASI. Resources>Indexing>Editing


Allegro Time!

Allegro Time! provides practical ideas for professional technical communicators. It will help you to assist your customers find answers in the documentation you've put so much effort into writing. Indexing topics covered include print manuals, online help keywords, single-source publishing, multimedia and the Internet.

Allegro Time!. Journals>Editing>Indexing


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


American Society for Indexing

ASI is the only professional organization in the United States devoted solely to the advancement of indexing, abstracting, and database building.

ASI. Organizations>Editing>Indexing


The Art of Indexing and Some Fallacies of its Automation

The phrase 'information storage and retrieval,' coined in the fifties - when computers were first harnessed to the twin tasks of recording verbal communication and finding it again on demand - is somewhat misleading and it is also missing a vital element. The misleading part is that many people seem to believe that these tasks can only be performed by machines. Yet information has been stored on stone tablets, papyrus rolls and in books for thousands of years and it has also been found when needed. The missing part is that, in order for stored information to be retrievable - whether manually or by machine - an intermediate operation is of crucial importance: the stored information must be indexed.

Wellisch, Hans H. CPD (1992). Articles>Indexing>Information Design


Ask the Indexer: Get Answers to your Indexing Questions from Experienced Technical Indexers  (link broken)   (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


Australian and New Zealand Society of Indexers  (link broken)

The Australian and New Zealand Society of Indexers (ANZI) aims to represent the interests of indexers and to provide training and other resources to all Australians and New Zealanders involved in indexing, whether they are freelancers or employees, full-time, part-time or casual.

ANZSI. Organizations>Editing>Indexing>Australia


Automating Your Word Indexes   (PDF)

Have you ever tried to create an index in Word? Were you dissatisfied with the options available in the dialogs? There are other features available that can provide you with a higher level of control over the structure of the index. This article gives you an overview of advanced indexing techniques; see Word’s online help for details. The menu sequences are for Word 2000; there are slight differences in Word 2002.

Unwalla, Mike. TechScribe (2003). Articles>Indexing>Software>Microsoft Word


Basic Indexing Techniques  (link broken)

If you're like most technical writers, you have had little (if any) training in creating indexes for the documents you produce. Even technical writers who graduate from Technical Communication degree programs receive little or no training in writing indexes. Consequently, most technical writers learn indexing 'by the seat of their pants ' and, unfortunately, many of the indexes they produce fall short of readers' needs.

Lathrop, Lori M. Boulder Writers Alliance (1997). Articles>Indexing


Basic Indexing Workshop  (link broken)   (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. If you have ever been in this situation or anticpate ever being in this situation, this workshop is for you. You’ll learn the six steps required to produce an index that is thorough and easy to use. Then you’ll practice two of those steps: selecting index entries and refining the rough draft of the index. Finally you’ll compare your individual efforts to the rest of the group to see how you did, what more you could have done, and what you can suggest to the rest of the group.

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


Cataloging Information Aids Help Development

Context-sensitive help systems often need redundant placement of information. This ensures that the information is seen by visitors who enter and move unpredictably through the system. Redundant placements take the form of descriptions, explanations, warnings, and the like that amplify other subjects. In software documentation, for example, some candidate subjects include the purposes of screens and tabs, the effects of selected options and significant functions such as Delete, and reminders of required access permissions and prerequisite steps or conditions. You can save development time and promote consistency by cataloging information so that it can be inserted wherever needed using your authoring software's copy and paste functions.

Barten, Alfred. Boston Broadside (2001). Articles>Documentation>Indexing


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


Comparing Indexing Approaches: Diversity in Style and Content  (link broken)

Indexers, like other freelancers, often work alone. Although they have unlimited access to indexes prepared by others via the bookstore or public library, they rarely have the opportunity to meet with other indexers to talk about indexing, indexing techniques, or a project they may be struggling with. This can be frustrating for both beginning and advanced indexers, especially those who receive little feedback from clients about the quality of their work.

Rowland, Marilyn. Editorial Freelancers Association (1995). Careers>Freelance>Indexing


Complexity In Indexing Systems -- Abandonment And Failure: Implications For Organizing The Internet

The past hundred years have seen the development of numerous systems for the structured representation of knowledge and information, including hierarchical classification systems with notation as well as alphabetical indexing systems with sophisticated features for the representation of term relationships. The reasons for the lack of widespread adoption of these systems, particularly in the United States, are discussed. The suggested structure for indexing the Internet or other large electronic collections of documents is based on that of book indexes: specific headings with coined modifications.

Weinberg, Bella Hass. ASIST (1996). Articles>Indexing>Information Design


Consideration in Indexing Online Documents

Printed indexes were the precursors to hypertext links. If you have good indexing skills, you can apply those skills to writing indexes for either printed books or online documents. Although locator systems are different in electronic media than in printed books, the basic principles of indexing apply to both online documents and back-of-the-book (b-o-b) indexes. Most online indexes look very much like b-o-b indexes; however, because online information is not linear, the biggest difference is that hypertext links in online documents serve the same purpose as See and See also cross-references in b-o-b indexes. Another difference is that most indexes for online documents use just one or, at the most, two levels of index entries--that is, main headings and subentries, but no sub-subentries.

Lathrop, Lori M. Boulder Writers Alliance (1996). Articles>Indexing>Online


Contents and Indexes  (link broken)

An index is a vital part of a user manual and a help file. A manual without an index is like a 21-storey house without a names board on the ground floor. You will have to search through all the floors in the building to locate your friend’s residence.

Kamath, Gurudutt R. IT People (2002). Articles>Indexing>Documentation


Converting Indexes with WebWorks Publisher

While WebWorks Publisher (WWP) 7.0 can convert FrameMaker indexes into different online formats, getting things to work initially can be a bit of a challenge. Page ranges in index entries result in hyperlinks to both the starting and ending locations. Index hyperlinks don’t always link to the top of a help topic, but often to somewhere in the middle. For Simple HTML and Dynamic HTML, “See” and “See also” references can fail to convert altogether. However, if you do get stuck, Customer Support can help pull you through.

Brown, Fred. Allegro Time! (2002). Articles>Indexing>Software>Adobe FrameMaker


Creating an Index in Microsoft Word

For technical writers, a well-crafted index helps organise the writing process, in particular, when you get to the production stage.

Klariti. Articles>Indexing>Software>Microsoft Word


Creating Coloured Hyperlinks in an Index in a PDF File

This article explains how to create coloured hyperlinks in an index in a PDF file, using Microsoft Word as the source document for the PDF file. Many authors create PDF files using Word as the source document. Most Word-to-PDF converters create a hyperlink in the PDF file if a hyperlink exists in the Word document. Unfortunately, Word does not create hyperlinked cross-references in an index, so no PDF creation tool can directly generate a hyperlinked index. The Sonar Bookends Activate plug-in for Acrobat creates hyperlinks for page numbers in indexes in PDF files. The plug-in does not change the colour of new hyperlinks, and it does not create visible rectangles for the hyperlinks. This article explains how to colour the hyperlinks in the Word source document using macro.

Unwalla, Mike. TechScribe (2006). Articles>Indexing>User Interface>Adobe Acrobat


Developing Indexes  (link broken)

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


Digital Libraries: Cataloguing and Indexing of Electronic Resources

A directory of resources in cataloguing and indexing online materials.

IFLANET. Resources>Indexing>Publishing>Online


DocBook (SGML/XML)

The DocBook document type definition (DTD) was developed during the 1990s to provide an application independent method for creating computer documentation. Versions of the DocBook DTD have been created for both SGML and XML. You can create an embedded index in DocBook using index elements.

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


Edit Your Index: A Checklist for Efficient Editing  (link broken)   (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



Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon