Browse Prior Art Database

Designing and Developing Articles on the Basis of Information Type

IP.com Disclosure Number: IPCOM000114926D
Original Publication Date: 1995-Feb-01
Included in the Prior Art Database: 2005-Mar-30
Document File: 2 page(s) / 76K

Publishing Venue

IBM

Related People

Dobrinski, BA: AUTHOR [+12]

Abstract

Described are small online information modules, called "articles," which describe only one subject, consist of only one information type, and answer only one question.

This text was extracted from an ASCII text file.
This is the abbreviated version, containing approximately 52% of the total text.

Designing and Developing Articles on the Basis of Information Type

      Described are small online information modules, called
"articles," which describe only one subject, consist of only one
information type, and answer only one question.

      Product documentation designed and developed as small modules
called articles helps users to retrieve the appropriate information
and to understand that information.  An article describes only one
subject, consists of only one information type, and answers only one
question.

      Product documentation must be not only accurate and complete;
it must also be easy to retrieve and understand.  Retrievability and
understandability are improved by designing and developing the
documentation in small modules called articles.  An article describes
only one subject, consists of only one type of information, and
answers only one question.

      Each article includes a heading and at least one index entry,
so the larger number of access points to articles increases the
likelihood of finding a topic.

      In addition, if guidelines are established for the content and
format of articles, headings become consistent and predictable.  As a
result, readers can rely on an article to contain the type of
information its heading implies.

      Articles make documentation easier to understand because each
article is small (the goal is a maximum of 500 words per article) and
begins with a purpose statement.  Those constraints force the article
to focus on answering a specific qu...