Computer-based documentation and instruction

• US 6,724,401 B1
• Filed: 01/25/1999
• Issued: 04/20/2004
• Est. Priority Date: 07/07/1997
• Status: Expired due to Fees

• Current Assignee: Axure Software Solutions Incorporated
• Original Assignee: International Business Machines Corporation
• Inventors: Hennum, Erik, Ott, Landon L.
• Primary Examiner(s): Nguyen, Cao (Kevin)
• Application Number:
  US09/236,105
• Time in Patent Office: 1,912 Days
• Field of Search: 345/333, 345/334, 345/335, 345/336, 345/337, 345/338, 345/339, 345/762, 345/765, 345/705, 345/707, 345/708, 345/764
• US Class Current: 715/765
• CPC Class Codes: G06F 9/453 Help systems

Abstract

User instruction on a computer system involves performing an interactive example and providing, in synchronization with the interactive example, explanatory information corresponding to the example. The explanatory information presented explains what most recently occurred in the interactive example and is updated automatically to correspond with the current state of the interactive example.

Claims

1. A computer readable medium having embodied thereon a computer program for processing by a computer, the computer program comprising:

a first code segment to maintain a body of source code including source code files for a computer-based application that includes an instructional example;

a second code segment to generate one or more clean source code files for the computer-based application;

a third code segment to build the computer-based application by compiling the source code files;

a fourth code segment to generate one or more documentation source files, including annotations from the source code files, corresponding to the computer-based application by parsing the body of source code to identify portions of the source code that correspond to annotations; and

a fifth code segment to produce the one or more documentation source files in a format for display by a web browser.

2. The computer readable medium of claim 1 in which the first code segment comprises program instructions and explanatory information in the body of source code.

3. The computer readable medium of claim 1 in which the first code segment comprises in the body of source code symbols for distinguishing between program instructions and explanatory information.

4. The computer readable medium of claim 1 wherein the body of source code includes symbols for identifying program instructions that are to be used for building interactive examples.

5. The computer readable medium of claim 1 wherein the body of source code includes symbols that define a manner in which the explanatory information is to be presented to an end-user.

6. The computer readable medium of claim 1 wherein the body of source code includes symbols that define a manner in which the explanatory information is to be presented to an end-user.

7. The computer readable medium of claim 1 further comprising a sixth code segment to assemble a list of predetermined tokens appearing in the body of source code.

8. The computer readable medium of claim 7 in which each token comprises a keyword.

9. The computer readable medium of claim 7 in which each token comprises a class name.

10. The new computer readable medium of claim 1 further comprising a sixth code segment to generate a link to an online reference for each token in the assembled list.

11. The computer readable medium of claim 1 wherein the body of source code includes symbols for identifying a source code fragment that is to be presented to an end-user.

12. The computer readable medium of claim 1 further comprising a sixth code segment to generate a jump that allows an end-user to access the body of source code at a location corresponding to the source code fragment.

13. The computer readable medium of claim 1 in which the parsing comprises processing the body of source code with a script that recognizes predetermined markup symbols appearing in the body of source code.

14. The computer readable medium of claim 1 in which the computer-based application can be executed by an end-user.

15. The computer readable medium of claim 1 further comprising a sixth code segment to permit a user to view the source code files in the context of execution of the predefined computer-based application.