JPH0581004A - Automatic document generation system - Google Patents

Abstract

PURPOSE:To obtain an automatic document generation system which automatically generates documents by dividing them into respective modules from a source file including the plural modules. CONSTITUTION:The automatic document generation system automatically generates the respective document files of a processing flow specification a table definition specification and a module definition specification from the source file 14 described by programming language. A document generation processing part 8 is provided for the automatic document generation system. When the source file 14 is composed of the plural modules, the processing flow specification file is divided into the respective modules and respective document files 13 are generated.

Description

Detailed Description of the Invention

[0001]

BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to an automatic document generation system, and more particularly, in a document automatic generation system for automatically generating a document from an existing source file for software development, a source file including a plurality of modules. The present invention relates to an automatic document generation system that automatically generates a document by dividing each module into a file.

[0002]

2. Description of the Related Art As described in Japanese Patent Laid-Open No. 1-237726, generally, in software development,
A method is used in which the function of the software to be developed is defined, the software that realizes the function is stepwise detailed, the design is advanced, and the program is finally created. Focusing on the form of software development, each document of the table definition specification and the module definition specification is first created, and then the process flow specification is detailed, and then the source program is created.

Further, in the development mode in which an existing program is diverted, as in the case of software development in which a program is created using a program that has been preliminarily made into a component, a basic definition such as a table definition specification and a module definition specification is required. Each document does not exist, only the source program exists. In such a case, a document is manually created based on the source program, and subsequent software development is advanced. Incidentally, in the program development of a system which is not particularly complicated, there is a case in which the documents are not created at all and the subsequent software development is advanced.

By the way, when software development is carried out in such a program diversion development form, when the development process is traced back, the creation of the document does not entirely depend on manual work. JP-A-1-
As described in Japanese Patent No. 237726, there is a case in which a job control statement is analyzed by using an automatic generation system of software specifications and a data flow document or the like is created from a file for each job.

[0005]

Conventionally, an automatic document generation system for automatically generating a document from a source file has been developed as described in the above-mentioned Japanese Patent Laid-Open No. 1-237726. Such an automatic document generation system automatically generates documents from ordinary source files.
The contents are simply output for each source file. Therefore, if the source file is composed of multiple modules, the output result will be a document of a collection of multiple modules, and should be managed as a document for each module according to the substance of each program in the source file. However, there is a problem that it cannot be put to practical use.

In particular, when it is desired to divide a source file composed of a plurality of modules into module units, the target source file must be divided before starting the automatic document generation system for generating a document. However, there is a problem that the operation is complicated.

The present invention has been made to solve the above problems, and an object of the present invention is to provide a source file in a document automatic generation system for automatically generating a document from an existing source file for software development. An object of the present invention is to provide an automatic document generation system capable of automatically creating a process flow specification by dividing each processing module when each module is composed of a plurality of modules.

[0008]

In order to achieve the above object, the automatic document generation system of the present invention uses a process flow specification, a table definition specification, a module definition specification from a source file written in a programming language. A document automatic generation system that automatically generates each document file of a document, and when the source file consists of multiple modules, a document that creates a document file by dividing the process flow specification file for each module It is characterized by comprising a generation processing unit.

Further, the document generation processing section analyzes the processing flow of the source file when creating the document file of the processing flow specification from the source file, and when the instruction word for calling another module is detected in the processing flow, Generate another file that stores the document file of the process flow specification for the other module to be called, create the document file of the process flow specification for the other module, store it in another file, and then It is characterized by creating a document file.

[0010]

In the automatic document generation system of the present invention,
A document generation processing unit is provided, and the processing flow specifications, table definition specifications, from the source file in which the document generation processing unit is described in a programming language,
Automatically generate each document file of module definition specifications. The automatic generation of the document file, when the source file consists of multiple modules,
Create a document file by dividing the process flow specification file for each module. When creating a document file of a processing flow specification from a source file, the document generation processing unit analyzes the processing flow of the source file, and when it detects an instruction word that calls another module in the processing flow, Generate another file that stores the document file of process flow specifications. Then, after creating a document file of a process flow specification for another module and storing it in another file, a document file of the process flow specification of the calling side is created.

As described above, the document file of the processing flow specification is created from the source file. When a plurality of other modules exist in the source file,
For example, when an instruction word for calling another module is detected, a storage file for storing a document file of another processing flow specification for the called other module is secured. Then, after creating the process flow specification document file for the module and storing it in a separate storage file, continue to create the process flow specification document file of the calling side and store the document file. To do. As a result, a document file in which a plurality of modules are divided can be automatically generated from a source file including a plurality of modules.

In this automatic document generation system,
Since the processing flow definition file is created for each module, the maintenance work and the management work of the document can be facilitated even in the source file of a large-scale program including a plurality of modules. This allows
Predetermined quality is ensured in system maintenance, and software development productivity is improved.

[0013]

Embodiments of the present invention will be specifically described below with reference to the drawings. FIG. 1 is a system configuration diagram showing the overall configuration of a software development support system including an automatic document generation system according to an embodiment of the present invention. In FIG. 1, 1 is a keyboard as an input device, 2 is an editor unit, 3 is a specification editor, 4 is a process flow editor,
5 is a data analysis unit, 6 is a text file analysis unit, 7 is an internal data analysis unit, 8 is a document / source automatic generation unit, 9 is a source generation unit, 10 is a document generation unit, 1
Reference numeral 2 is an internal data file, 13 is a document file, and 14 is a source file. Further, 15 is an output device.

By inputting the keyboard 1, the editor unit 2
Then, the specification editor 3 and the processing flow editor 3 of the editor unit 2 are used. The specification editor 3 of the editor unit 2 edits table definition specifications, module definition specifications, and the like. Further, the processing flow editor 4 edits processing flow specifications.

The specification data edited by the editor unit 2 is once rewritten in the internal data format, converted into the internal data file 12 and stored. The data in the internal data format of the internal data file 12 is analyzed by the internal data analysis unit 6 of the data analysis unit 5, a document in text format data is generated and stored as the document file 13. Further, when converting the document of the text format data of the document file 13 into the data of the internal data format, the text file analysis section 6 of the data analysis section 5 converts the data into the internal data format data, and then the internal data file. Returned to 12.

Since the data stored in the document file 13 is stored as text data, it can be output to the output device 15 as it is by using the data output function provided by the existing operating system. Has become. Therefore, the correction of the document of the text format data stored in the document file 13 can be performed by directly accessing the document file 13 without using the editor unit 2.

In the document / source automatic generation unit 8,
The source generation unit 9 generates the source file 14 from the document file, and the document generation unit 10
From the source file 14 to the document file 13
Is generated.

FIG. 2 is a diagram showing the flow of processing of the document generation unit. The process of automatically generating a document from a source file will be described. When a source file 14 that is a base for generating a document is given, the document automatic generation unit 10 creates a document file 13. In this document automatic generation processing, a table definition specification file 16, a module definition specification file 17, and a processing flow specification file 18 according to the module specifications, table specifications, and source program processing flow in the source file 14.
Are the document files 13 configured as separate files.

FIG. 3 is a diagram for explaining a process of automatically generating a process flow specification from a source file composed of a plurality of modules. This processing is performed by the document / source automatic generation unit 8. The process of automatically generating a process flow specification of a source file composed of a plurality of modules will be described with reference to FIG. 3. The process of a source program written in a programming language in a source file 14 which is a basis for automatic document generation When the flow is given, this programming language is analyzed and the processing flow specification file 18 is created. As shown in FIG. 3, in the source file 14, when "sub1.sysl" of the program module 30 is given,
First, the syntax 31 of "SUB1: PROC;" is used to specify "sub" in the process flow specification file 18.
1. hcp ”module processing flow specification file 1
Create 9. Next, as the document generation process proceeds, when the source file 14 recognizes the syntax 32 of “CALL SUB2;” of the program module 30, a text data document 33 for the same is generated, and the process flow specification document is generated. Create and register as. Then, at this time, a module processing flow specification file file 20 of “sub2.hcp” is further created as a processing flow specification file.

In the analysis of the processing flow of the program module 30 of the source file 14, "CALL S
UB2; ”, the analysis is performed on the syntax group 34 of the module that is the subroutine because the analysis of the syntax 32 is performed. Therefore, the subsequent document creation processing is“ sub2.hcp ”in the creation of the processing flow specification file. The file creation of the module processing flow specification file 20 is continued. When the end of the executable statement (syntax END) is analyzed by the analysis in the syntax group 34 of the program module 30,
Here, the module processing flow specification file 20 of “sub2.hcp” that has already been created is stored first. Then, the processing is continued in the same manner, and the end syntax 3 of the execution statement corresponding to the module processing flow specification file 19 of “sub1.hcp” in the creation of the processing flow specification file 3
4 is analyzed, the module processing flow specification file 19 here is stored.

The process flow specification file 18 is not stored until all the execution statements in the process flow specification file 18 thus created are completed.
When another module is called in the analysis of the processing flow of the source file 14, when the calling syntax of the module is analyzed, the module processing flow specification file 19 and the module processing flow specification file 2
A new process flow specification file such as 0 is newly created. In this way, the document file and the source file are mutually converted.

[0022]

As described above, according to the automatic document generation system of the present invention, a process flow specification file is generated for each module even if the source file is a process flow including a plurality of modules. Therefore, each module can be easily managed. Also, in software development, even when specifications change in the test process and operation, the automatically generated process flow specifications can be modified by an editor. Then, after that, the source file is generated again by the automatic source generation system, so that the maintenance of the single module whose specification has been changed can be easily performed. Further, since the document file is a text file, even if the editor of the document automatic generation system goes down, it can be modified by the existing editor, and the maintenance becomes easy.

[Brief description of drawings]

FIG. 1 is a system configuration diagram showing the overall configuration of a software development support system including an automatic document generation system according to an embodiment of the present invention,

FIG. 2 is a diagram showing a processing flow of a document generation unit,

FIG. 3 is a diagram illustrating a process of automatically generating a process flow specification from a source file composed of a plurality of modules.

[Explanation of symbols]

 1 keyboard (input device) 2 editor section 3 specification editor 4 processing flow editor 5 data analysis section 6 internal data analysis section 7 text file analysis section 8 document / source automatic generation section 9 source generation section 10 document generation section 12 internal data file 13 Document File 14 Source File 15 Output Device 16 Table Definition Specification File 17 Module Definition Specification File 18 Processing Flow Specification File 19 Module Processing Flow Specification File 20 Module Processing Flow Specification File

Claims (2)

[Claims] 1. An automatic document generation system for automatically generating each document file of a processing flow specification, a table definition specification, and a module definition specification from a source file written in a programming language, and a plurality of source files are provided. An automatic document generation system characterized by comprising a document generation processing unit that divides a processing flow specification file for each module when it is composed of modules and creates a document file. 2. The document generation processing unit, when creating a document file of a processing flow specification from a source file, analyzes the processing flow of the source file, and detects an instruction word that calls another module in the processing flow, Generate another file that stores the document file of the process flow specification for the other module to be called, create the document file of the process flow specification for the other module, store it in another file, and then The document automatic generation system according to claim 1, wherein a document file is created.