JPH0358138A - System for preparing manual of program pattern - Google Patents

Abstract

PURPOSE:To synchronize a specification code and processing explanation by inputting summary explanation to a manual record with the specification code as the key. CONSTITUTION:This system is provided with a pattern source reading means 1 which reads in a program pattern, an instruction analysing means 2 which discriminates the added number of the specification code as the key of processing explanation of the manual in accordance with the read-in source, a specification code source adding means 3 which gives the analysed specification code to the program pattern source, a manual output means which outputs the analysed specification code and the procedure name of the program pattern source as a manual record, a processing summary input means 5 which inputs summary explanation to the manual record with the specification as the key, and a manual printing means 6 which prints the manual record by a printer. The program pattern source and the manual of standard program patterns are always synchronized with each other. Thus, though the program pattern source is added or deleted by function remodeling, they are always synchronized to reflect addition or deletion on the manual of program patterns.

Description

[Detailed Description of the Invention] [Industrial Application Field] The present invention is a method for creating a manual for a standard program pattern from a source program (hereinafter referred to as a program pattern source) for a standard program pattern created as a software development support tool. This article relates to a method for creating a program pattern manual.

[Conventional technology]

Conventionally, the program pattern source and the standard program pattern manual were created separately, and the specification code, which is a key code to explain the processing of the standard program pattern, was manually numbered on the program pattern. ,
The manual includes a separate explanation of the corresponding specification code.

[Problem to be solved by the invention]

In the conventional method of manually creating program pattern instructions described above, the program pattern source and the standard program pattern instructions are worked on separately, so the specification code and processing explanation may not be synchronized. There is a problem.

Furthermore, if there is a functional modification after the program pattern source and the standard program pattern manual have been completely revised, the program lines added or deleted in the program pattern source will be renumbered, and the standard program pattern manual will be renumbered. However, there is a problem in that it must be corrected separately.

[Means to solve the problem]

As shown in FIG. 1, the method for creating a program pattern manual of the present invention includes a pattern source reading means 1 for reading a program pattern, and a specification code that is a key to manual processing explanation from the read source. Instruction analysis 1000 steps 2 for determining the numbering, specification code source addition means 3 for adding the analyzed specification code to the program pattern source, and procedure name of the analyzed specification code and program pattern source as an instruction record. It includes a manual output means 4 for outputting a manual, a process summary input means 5 for inputting a summary description using a specification code as a key for a manual record, and a manual printing means 6 for printing the manual record on a printer, The program pattern source and the standard program pattern manual are always synchronized.

〔Example〕

Next, the present invention will be explained with reference to the drawings.

FIG. 2 is an example of an image of a program pattern source after implementing the present invention. The instructions of the program pattern source consist of a program control part and a user description part, and the PERFORM command that calls the procedure name written after the user description processing which is a comment line becomes the user description part. Instructions other than these serve as a perogram control section. That is, in the program pattern source of FIG. 2, the PERFORM instruction with procedure name 1 becomes the user description section, and the PERFORM instruction and MOVE instruction with procedure name 2 become the program control section. Therefore, by setting the specification code rules as shown in Figure 3, the specification codes AOOIU, AOO2S, and AOO3S can be assigned IDs.
Attach to the area and output. Also, in the user description section, the specification code is inserted as a comment line one line before the procedure name.

Figure 4 shows the data contents of each phase after creating a new program pattern source, that is, when the present invention is used for the first time (new mode). The specified specification code is added to the program pattern source and output. Next, the specification code and procedure name (PERFORM
Instructions only) are output to the instruction record. After that, input the processing outline into the manual record from the terminal, and print the manual if necessary.

FIG. 5 shows the data contents of each phase after the functional modification of the program pattern source, that is, when the present invention is used for the second time or later (modification mode), and the processing flow is as follows:
First, the program pattern source is read, and the analyzed specification code is added to the program pattern source and output. At this time, even if the specification code is written in the original program pattern source, it is ignored. Next, the previously input processing summary is saved, and the specification code and procedure name (PERFORM command only) are output to the instruction record. After this, the changed or added processing outline is input from the terminal into the manual record, and if necessary, the manual is printed.

〔Effect of the invention〕

As explained above, according to the present invention, even if a program pattern source is added or deleted due to functional modification, etc., it is always synchronized and reflected in the program pattern's introduction, and the program pattern can be converted into a document file. Since the system is a collection of records), the user can get an overview of the process from the document file, and operations can be performed without the need for manuals. Furthermore, since the specification code is not added manually, it is possible to prevent the specification code in the program pattern source or the program pattern manual from being messed up or from writing errors.

[Brief explanation of drawings]

Figure 1 is an elliptical diagram of the present invention, Figure 2 is an image of the source program of the standard program pattern after implementing the present invention, Figure 3 is a format diagram of an example of the rules of the specification code, and Figure 4 is the standard Figure 5 shows the data contents of each phase after creating a new source program of the program pattern source, that is, using the present invention for the first time. Figure 5 shows the data content of each phase after the source program of the standard program pattern has been modified, that is, using the present invention for the second time. It is a diagram showing the data contents of each phase used thereafter. DESCRIPTION OF SYMBOLS 1... Pattern source reading means, 2... Instruction analysis means, 3... Specification code source addition means, 4... Instruction output means, 5... Process summary input means, 6... Explanation Calligraphy printing means.

Claims (1)

[Claims] a pattern source reading means for reading a source program of a standard program pattern; an instruction analysis means for determining the numbering of a specification code, which is a key to a manual's processing explanation, from the source program read by the pattern source reading means; specification code source addition means for adding the specification code determined by the instruction analysis means onto the source program; and instruction output for outputting the specification code and the procedure name of the program pattern source determined by the instruction analysis means as an instruction record. a processing summary input means for inputting a summary explanation into the instruction record using a specification code as a key; and an instruction printing means for printing the instruction record on a printer. method.