Browse Prior Art Database

A method of smart indexing in authoring tools

IP.com Disclosure Number: IPCOM000241491D
Publication Date: 2015-May-06
Document File: 4 page(s) / 70K

Publishing Venue

The IP.com Prior Art Database

Abstract

The invention enables smart indexing in the authoring tools. Information developers can rely on the authoring tools to automatically index the documents.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 53% of the total text.

Page 01 of 4

A method of smart indexing in authoring tools

Index entries are important signposts for readers to find the information that they need. Information developers, also known as technical writers, must create an adequate number of index entries to ensure that the product documentation is retrievable. The three main ways that users find information are search, navigation, and index.

The following screen capture shows part of the index entries of one publication. Generally speaking, index entries are composed of the following items:

Main entries

Subentries including secondary entries and tertiary entries


Locators, that is, online links or page numbers Cross-references

1



Page 02 of 4

To create those index terms, information developers have to specify the tags and nested structures carefully in the authoring tool. ID writers also need to make sure that they follow the corresponding indexing guidelines. Companies often have specific guidelines of what to

2



Page 03 of 4

index, how to structure entries, and how to word the entries.

The following screen capture shows how writers specify tags to create index terms in a sample authoring tool.

As we can see from the preceding screen captures, the current method of indexing in information development has the following drawbacks:
Bears high possibility of inconsistency and guideline incompliance

Consumes time and effort

Requires in-depth skills and knowledge

The invention enables smart indexing in the authoring tools. Information developers can rely on the authoring tools to automatically index the documents.

Compared with the traditional way of indexing...