System and method for automated annotation of files

Details System and method for automated annotation of files System and method for automated annotation of files

1999-01-11

2003-06-03

Feild, Joseph H. (Department: 2176)

Data processing: presentation processing of document, operator i

Presentation processing of document

Layout

C717S122000, C717S124000

Reexamination Certificate

active

06572661

ABSTRACT:

FIELD OF THE INVENTION
The present invention is related to computer software and more specifically to automated training computer software.
BACKGROUND OF THE INVENTION
To train engineers on the operation of complex computer software, it can be helpful to perform a “code walk-through.” In a code walk-through, engineers being trained are shown a portion of the computer software source code known as the code, as an instructor describes how that portion of the code operates. The description may contain an explanation of a complexity or nuance that an engineer might not notice by himself.
The problem with a code walk-through is that it is very labor-intensive. A trained instructor must perform it with one or more engineer-trainees. The instructor and the engineers are required to be present at the same time to perform the walk-through. Because of the expense of the instructor, code walk-throughs may be scheduled only when a sufficient number of engineers require training. The first engineers to require training must wait until others require it as well; leaving the first engineers untrained for some period of time. If the instructor leaves the company, he must train another trainer, which is not only labor intensive, but can also cause details to become lost if they are not communicated from one trainer to the next.
These problems have been addressed with text-based code walk-throughs. A text-based code walk-through contains the code and explanatory material in text-based form. For example, one side of a page may contain the software code and the other side contains a text based description of the code, similar to that which an instructor would relate in a classroom. Arrows from the description to the relevant code section may be placed on the page to allow the reader to identify the pertinent code section described. Instead of arrows, a footnote arrangement may also be used.
However, as the computer software being described changes, the description must move with the pertinent section of the code it describes to allow the engineer trainees to easily locate the code being described. For a large computer program that may change frequently, the maintenance of the description becomes a monumental task. This task is made even more difficult when minor changes are made to the code described by the description, making it difficult to locate the pertinent code section described.
What is needed is a method and apparatus that can allow a text based code walk-though description to automatically change location with the pertinent code, even if minor changes are made to the text of the code itself.
SUMMARY OF INVENTION
A method and apparatus reads two files, a source file, containing an item such as source code, and an annotation file, containing descriptions of different portions of the item. The annotation file also contains commands to the method and apparatus, beginning with codes known as “tags”. The method and apparatus writes two output files, an annotation HTML file and a source HTML file, that are similar to the corresponding input files, except they do not contain the commands, and contain cross links to the other output file, allowing the relationship between the annotation HTML file and the source HTML file to be automatically generated. The tags describe where to locate the cross links. A “match tag” instructs the method and apparatus to build a cross link between the current location of the annotation HTML file and a specific location in the source HTML file. The specific location is identified by the method and apparatus by locating text in the source input file that is similar to the text contained in the command beginning with the match tag. A command beginning with a “set confidence level tag” determines the degree of similarity required to identify the specific location in the source HTML file. Other commands starting with other tags allow HTML commands or spaces to be inserted into the annotation HTML file. The method and apparatus can build other links to the other output file as well as links within the same output file.


REFERENCES:
patent: 5303361 (1994-04-01), Colwell et al.
patent: 5465353 (1995-11-01), Hull et al.
patent: 5717922 (1998-02-01), Hohensee et al.
patent: 5764972 (1998-06-01), Crouse et al.
patent: 5784608 (1998-07-01), Meske, Jr. et al.
“Microsoft Press Computer Dictionary” Microsoft Corporation, Third Edidition, 1997, p. 24.

Affiliated with

Also associated with

Rating

System and method for automated annotation of files does not yet have a rating. At this time, there are no reviews or comments for this patent.

If you have personal experience with System and method for automated annotation of files, we encourage you to share that experience with our LandOfFree.com community. Your opinion is very important and System and method for automated annotation of files will most certainly appreciate the feedback.

Rate now

Comments { 0 }

Profile ID: LFUS-PAI-O-3105087