JPH04342024A - Document preparing system dealing with program - Google Patents

Abstract

PURPOSE:To easily standardize the contents of a document and a source program, and to efficiently execute maintenance by preparing and updating the document based on the latest source program. CONSTITUTION:The above system is constituted of an SU part 1 to store the source program, an SU part 2 dealing with the document to store the source program at the time of documentation, a document data part 3 to store document data corresponding to the source program, an SU analyzing part 4 to instruct the preparation of the document based on the source program, terminal equipment 5 to give an instruction to operate the document, and a document preparing part 6 to update the source program to deal with the document of the document data in conformity to the instruction from the terminal equipment.

Description

[Detailed description of the invention]

0001

BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to the development of information processing software, and more particularly to a program-compatible document creation method.

0002

2. Description of the Related Art Conventionally, when producing a program in software development, a document called a program design document is created, and then a program is constructed using an appropriate programming language.

0003

[Problem to be solved by the invention] In conventional document creation methods, once documents and programs have been created, unification of the contents through changes must be done manually, and maintenance requires specialized knowledge and a lot of work. The problem is that it requires a lot of effort.

0004

[Means for Solving the Problems] A method for creating a document corresponding to a program according to the present invention includes an SU analysis unit that analyzes and displays and edits a source program and a document corresponding to the source program, and an SU analysis unit that analyzes and displays and edits a source program and a document corresponding to the source program, and an instruction to display and update the document. It is characterized by having a document creation section that creates and updates document data.

[0005]

DESCRIPTION OF THE PREFERRED EMBODIMENTS The present invention will be explained with reference to the drawings.

FIG. 1 is an explanatory diagram showing one embodiment of the present invention. In the same figure, the program-compatible document creation method consists of an SU section 1 that stores the source program for which you want to create a document, a document-compatible SU section 2 that stores the source program when documenting it, and document data corresponding to the source program. a document data section 3 that stores document data, an SU analysis section 4 that issues document creation instructions based on the source program, a terminal device 5 that issues document manipulation instructions, and a document corresponding source program for document data according to instructions from the terminal device. It is composed of a document creation section 6 for updating.

A source program is registered in the SU unit 1 using an editor or the like.

[0008] The SU analysis section 4 and the document creation section 6 operate according to dialog input instructions from the terminal device 5.

The contents of the document correspondence SU section 2 and the document data section 3 are registered and updated by the document creation section 6.

[0010] The SU analysis unit 4 instructed by the terminal device 5 imports the specified source program and the document-compatible source program/document data (in the case of existing data) from the external storage device, and compares the source program and the document-compatible source program. The change information is reflected on the document data and edited and displayed on the terminal device 5. The document creation unit 6 updates the document data based on the information (text) input from the terminal device 5, and replaces the document corresponding program with a new source program.

FIG. 2 is an explanatory diagram showing an example of data. At the same time, when a source program that has created a document is changed, the latest source program after the update is
Next, the source program before update is loaded into the text-corresponding SU area 12, and the previously created text data and the index corresponding to the source program are loaded into the text data area 13.

Then, as shown in FIG. 3(a), the text data taken into the text data area 13 of the source program taken into the SU area 11 is displayed on the terminal device, and the S
The contents of the U area 11 and the text-corresponding SU area 12 are compared to highlight differences.

Next, as shown in FIG. 3(b), while looking at the data on the terminal device, instructions are given to modify text data (change, register, delete text, and position it with the source program).

[0014]

Effects of the Invention The present invention has the advantage that by creating and updating documents based on the latest source program, the contents of the document and the source program can be easily unified and maintenance can be performed efficiently.

[Brief explanation of the drawing]

FIG. 1 is an explanatory diagram showing one embodiment of the present invention.

FIG. 2 is an explanatory diagram showing an example of data.

FIGS. 3(a) and 3(b) are explanatory diagrams showing the operation.

[Explanation of symbols]

1 SU Department 2 Document support SU section 3 Document data section 4 SU analysis department 5 Terminal device 6 Document creation department

Claims (1)

[Claims] [Claim 1] SU that analyzes and displays and edits a source program and a document corresponding to the source program.
A program-compatible document creation method comprising: an analysis section; and a document creation section that creates and updates document data based on instructions for displaying and updating the document.