Browse Prior Art Database

Updating Online Documentation On The Fly

IP.com Disclosure Number: IPCOM000130354D
Original Publication Date: 2005-Oct-21
Included in the Prior Art Database: 2005-Oct-21
Document File: 2 page(s) / 46K

Publishing Venue

IBM

Abstract

This invention identifies a process for allowing Subject Matter Experts (SMEs) to submit changes to the online documentation HTML files rather than working directly with the documentation source files, and ensures that the source files are updated before the next revision of the online documentation.

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

Page 1 of 2

Updating Online Documentation On The Fly

As users read the online documentation after a product is released, inaccurate and incomplete information is often identified by subject-matter experts (SMEs), such as technical support personnel and experienced customers. Using traditional processes for feedback (online or hardcopy feedback forms) often take weeks or months to work updates into the online documents. To improve the user experience, change suggestions that are submitted by SMEs need to be dynamically updated (or nearly dynamically).

This invention identifies a process for allowing SMEs to submit changes to the online documentation HTML files rather than working directly with the documentation source files, and ensures that the source files are updated before the next revision of the online documentation. Before the changes could be made live, two reviews are necessary. An edit review ensures that the content is consistent and clear, and conforms to the IBM style guidelines. An approval review ensures that the changes are technically accurate before they are published.

The online document designer decides whether to allow on-the-fly change requests only from a limited set of known users or open it up to everyone. If it is limited to a set of known users, an authentication process would be necessary, but contact info would be automatically provided. If it is open to everyone, then contact information would need to be provided when the changes are submitted in...