Browse Prior Art Database

A business process to ensure consistency and accuracy in user documentation across a suite of related products

IP.com Disclosure Number: IPCOM000125763D
Original Publication Date: 2005-Jun-16
Included in the Prior Art Database: 2005-Jun-16
Document File: 4 page(s) / 93K

Publishing Venue

IBM

Abstract

A business process is disclosed that ensures consistency and accuracy in user documentation across a suite of related products.

This text was extracted from a PDF file.
At least one non-text object (such as an image or picture) has been suppressed.
This is the abbreviated version, containing approximately 53% of the total text.

Page 1 of 4

A business process to ensure consistency and accuracy in user documentation across a suite of related products

Disclosed is a business process that ensures consistency and accuracy in user documentation across a suite of related products. The business process can be summarized as follows:

Template with boilerplate is provided by a central technical writing team,


1.


2.

implemented in extensible markup language (XML)

The document is reviewed by a central team, who are technical writers who are

also experts on the technology. This process is known as the information development consistency review. This review verifies that all shared technology documents: 1) Have the same required content, 2) Have a consistent format and style, and 3) Adhere to guidelines for user documentation.

This process is unique from a typical technical review of documentation because this process is the union of a special type of a review with the use of boilerplate text embedded in an XML template. Additionally, technical reviews by individual subject matter experts did not catch global issues or inconsistencies across products within a suite, technical reviewers did not have the technical writing expertise to identify completeness and consistency problems, and simply using boilerplate text did not address the issues of boilerplate being modified inaccurately, incompletely, or with out-of-date material. In addition to creating reference information, the XML template also generates task-oriented procedures.

The following are details of how the process is implemented (see figure 1):

1. An engineer uses the XML file from the central repository to specify the product. A toolkit uses this XML f...