JPH1185491A - Automatic generation system for plural documents - Google Patents

Abstract

PROBLEM TO BE SOLVED: To provide an automatic generation system for plural documents which can remove problems related to a software miss such as a miss in change to another related document even when one document is changed. SOLUTION: The system has a document analysis registering part 11 for setting up a design package, a source program, a header file, and a test procedure document to be prepared in software development as tag-added documents and registering information in the same data base for every item of a tag, a data base 13 for storing information in each tag and a document generation part 14 for generating the design package, the source program, the header file, and the test procedure document based on the contents of the data base 13, and when information is changed in any one of the design package, the source program, the header file, and the test procedure document after initial preparation of design package and initial registration in the data base 13, the information is registered in the same data base 13, so that a design package, a source program, a header file, and a test procedure document can be automatically generated if necessary.

Description

DETAILED DESCRIPTION OF THE INVENTION

[0001]

The present invention relates to a system for automatically generating a plurality of documents. Amid a software crisis, the CASE tool (a comprehensive program support tool) that provides an integrated software development environment from design document creation to programming and debugging is aimed at streamlining software development. Circulating. The present invention relates to a software development method using the CASE tool.

[0002]

2. Description of the Related Art In software development, function names, function outlines, parameters,
A design document that describes interface information such as a return value (type of output interface with respect to input) is created, and a header file that defines an interface of a function necessary for programming is created based on the design document. In addition, a source program for actually performing processing is created from the design document, and a test procedure manual is created as a document for testing the created source program.

FIG. 13 is a conceptual diagram of a conventional document creation system for creating a source program, a header file, and a test procedure manual from a design document. The design document (DOC) 1 for creating a program includes a function name, an outline of the function of the function, a parameter that is an interface of the function, and a return type indicating the end state of the function (a type that handles numerical values and characters in the program). And return value type (character and numeric type) are described.

The return type (HED) of each function in the header file (HED) 3 is based on the contents described in the design document 1.
1) A header file 3 that describes a function interface such as a function name (HED2) and a parameter (HED3) and defines a programming function interface.
Create

A return type (SRC1) in a source program (SRC) based on the contents described in the design document 1,
The function name (SRC2) and the parameter (SRC3) are described, and actual processing for realizing the contents described in the functional outline (DOC2) of the design document 1 is created in the programming unit (SRC4).

Further, based on a design document 1 for verifying the execution of the created source program, a test procedure document (TE
Test target function (TES1) and test conditions (TES) in S)
2) Description of parameters that need to be set, actual test procedure (TES3), expected confirmation contents (TES4)
And a test procedure manual 4 is prepared.

[0007]

FIG. 14 is a diagram showing the relationship between design documents, source programs, header files, and test procedure documents. The broken line in the figure indicates the range affected. In the conventional technology, for example, a design document (DO
C) When the parameter part (DOC1) of 1 is changed,
Source program 2 parameter description part (SRC1),
A plurality of documents such as the parameter part (HED1) of the corresponding function in the header file (HED) 3 and the test condition part (TES2) of the test procedure manual (TES) 4 are affected. Omission of corrections in the document is likely to occur, management is difficult, and it is easy to cause a mistake in creating a program.

SUMMARY OF THE INVENTION The present invention has been made in view of the above problems, and it is an object of the present invention to eliminate a problem that may lead to a software error such as an omission of a change to another related document even when one document is changed. The purpose of the present invention is to provide a system for automatically generating multiple documents.

[0009]

Means for Solving the Problems (1) FIG. 1 is a block diagram showing the principle of the present invention. The same components as those in FIG. 13 are denoted by the same reference numerals. In the figure,
1 is a design document (DOC), 2 is a source program (SR)
C), 3 is a header file (HED), 4 is a test procedure manual (TES). Reference numeral 10 denotes a multi-document generation device (MUL) particularly provided in the present invention.

In the multi-document generating apparatus 10, reference numeral 11 denotes a document analysis and registration unit for registering information for each tag item in the same database; 13, a database for storing information in tag units; A document generation unit that generates a program, a header file, and a test document. Reference numeral 12 denotes an analysis content information creation unit (TMP) that receives data from the document analysis registration unit 11 and notifies the database of the data. The database 13 stores tags and information in pairs. The database 13 is common to each document.

The document generation section 14 generates a document of a source program, a header file, and a test procedure manual based on the generation basic data (DAT). Fifteen
Is a file for storing generated basic data. The contents of these generated basic data are source program 2,
The header file 3 and the test procedure manual 4 are notified. Also,
The contents of the source program 2, the header file 3, and the test procedure manual 4 are notified to the document analysis registration unit 11.

A tag (indicated by <> in the figure) is attached to the input design document 1 for each item, and the source program 2, the header file 3 and the test procedure manual 4 are also tagged documents.

The multi-document generation device 10 (MU)
L) retrieves the information corresponding to the tag name and the tag and combines the information registered in the database 13 with the document analysis registration unit (ANA) 11 that registers the information in the database 13 via the analysis content information creating unit 12. It comprises a document generation unit (GEN) 14 for generating a document. Further, the document generation unit 14 has generation basic data (DAT) in the file 15 for each type of document to be generated. For example, as a header file, the file 15 has necessary types of information as basic data.

In FIG. 1, when a tag-added design document 1 is input to a multi-document generating apparatus 10, the information is stored in a database 13 for each tag unit of information, and tags are created as needed based on information in the registered database. A source program 2, a header file 3, and a test procedure manual 4 are generated. The reason for providing a tag is that firstly, the document can be analyzed with reference to the tag, and secondly, when a part of the document is changed later, a key for searching which other part is affected is changed. It is because it can be used as.

After changing and adding information to the generated document, the information is input to the multi-document generating apparatus 10 again, and the information is registered in the same database 13 from which the document is generated. Thereafter, similarly, a document is generated when necessary from information registered in the same database, registered in the original database 13 after changing the document, and updating information is repeated.

Thus, for example, the header file 3
Is changed, the change information is notified to the document analysis registration unit 11, and the document analysis registration unit 11 registers the change contents in the database 13 as a pair with a tag. The document generation unit 14 stores the database 1
3, the source program other than the header file 3 and the test procedure manual 4 are regenerated based on the generated basic data. Thereby, the information of the relevant parts of the source program 2, the header file 3, and the test procedure manual 4 becomes the same. Therefore, the information does not conflict with other documents as in the conventional system.

According to the present invention, the efficiency of creation of a design document, a source program, a header file, and a test procedure manual in software development is improved, and omission of a change in the contents related between various software development documents is prevented. can do.

(2) In this case, when inputting information to a design document, an input screen is provided with an input field for each input information, and a tag is automatically added to the input information. And

According to the present invention, it is possible to eliminate the need for the user to be aware of the tag for each item. (3) The information of the design document, the source program, and the header file is overwritten on the same database, and overwriteable type information is added for each information item on the database.

According to the configuration of the present invention, it is possible to prevent the information other than the database overwritable type information from being rewritten. (4) Also, for each information item in the database, the information item corresponding to the last set development document type information is added. If the content to be registered has a difference from the information in the database, the last set development document type is added. Is displayed to determine whether or not to register the development document in the database.

According to the structure of the present invention, the information of the design document, the source program, and the header file is overwritten on the same database. Can be prevented from leveling down.

[0022]

Embodiments of the present invention will be described below in detail with reference to the drawings. First, an embodiment at the time of document registration will be described with reference to FIG. In FIG. 1, a design document (DOC) with a tag added for each item of information
1 is input, and the document analysis registration unit (ANA) 11
Then, information corresponding to the tag name and the tag is extracted, and analysis content information (TMP), which is intermediate information up to registration in the database 13, is created by the analysis content information creation unit 12.

FIG. 3 is a flowchart showing the operation of the analysis content information creation processing, showing the operation of the analysis content information creation unit 12. First, one line of data from the document analysis registration unit 11 is read (s1), and it is checked whether it is the end of the file (s2). If it is the last line of the file, the processing ends.

If it is not the last line of the file,
It is checked whether it is a start tag (s3). If it is not the start tag, the process returns to step s1. If it is a start tag, a new information table is created in the analysis content information (TMP) by linking to the previous table (s
4). Next, the extracted tag name is set in the tag field of the created information table (s5).

Next, information up to the end tag is extracted (s
6). Then, the extracted information is set in the information field of the created information table (s7), and the process returns to step s1. FIG. 4 is a diagram showing an example of a table format of analysis content information according to the present invention. In this figure, a table in the analysis content information (TMP) is searched, a function name is extracted from a table of a function name tag, and a function name link (F
LINK) is searched for a function that matches the function name on the table linked to LINK.

FIG. 5 is a flowchart showing the processing operation of registering information in the database according to the present invention, showing the operation of the analysis content information creating section 12. First, analysis content information (TM
A table of function name tags in P) is searched, and tag names are extracted (s10). Next, a search is made for a tag that matches the extracted tag name by following the function name link in the database 13 (s11). Next, it is checked whether the tags match (s12).

The above sequence is described in the database 1
3. If there is a table with the matching function name in 3, the function information link of the table with the matching function name (FLINK)
And the analysis contents information (TM) for the table in the database that matches the tag name of the analysis contents information (TMP).
The information on the table P) is copied.

If the tags match, the search position of the function information link in the database is set in the matching function name table (s13). Then, the information in the table other than the function name of the analysis content information is copied to the information corresponding to the tag of the table in the function information link from the search position (s1).
4).

The above sequence is described in the database 1
If there is no matching function name table in 3, a new function name table is created in the database 13,
The table is linked to a function name link (FLINK), and a table other than the function name of the analysis content information (TMP) is linked to the function information link (ILLINK) of the newly created function name table.

If the tags do not match in step s12, a table of newly extracted function names is created and connected to the function name link (s15), and a table other than the function name of the analysis content information is newly created in the function information link. (S16).

FIG. 6 is a diagram showing an example of a data format in a database according to the present invention. When a document is generated based on information registered in a database (DB), the generation basic data 15 (LS
The contents of the database are extracted based on the generation rule of T), and a document is generated. The case where the source program 2 is generated will be specifically described as an example.

When the type of the document to be generated, in this specific example, the source program 2 and the function name are input,
The function name link (FLINK) in the database 13 is searched, and a table of the function name that matches the generated function name is set as the head of the function information link (ILINK) search.

FIG. 7 is a flowchart showing a document generation processing operation according to the present invention.
The operation of FIG. First, a function link name in the database is searched, and a function name table that matches the generated function name is set as the head of the function information link search (s100). Next, one line of the generated basic data file 15 is read (s101).

Next, it is checked whether or not the end of the generated basic data is reached (s102). If it is the end, the process ends. If it is not the end of the generation basic data, it is checked whether the generation type of the generation basic data is “TAG” or “DIRECT” (s10).
3).

When the generation type of the generation basic data is "TAG", a table in the database 13 that matches the TAG name of the generation content of the generation basic data file 15 is searched (s104). Output table information to a file with a tag attached (s10
5). If "DIRECT", the file 15
Is output as it is (s10)
6).

In the above steps s104 and s105, when the generation type (F2) is a tag, a tag that matches the tag name of the generation content (F1) is searched from the beginning of the function information link (ILINK) search in the database 13. , And outputs the information of the table of the matched tags. Step s1
In a case 06, when the generation type (F2) is “DIRECT”, information of the generation content (F1) is output as it is.

Next, it is checked whether or not the repetition generation is REPEAT (s107).
The process is repeated while the table in the database 13 corresponding to the tag name of the generated content exists (s108). That is, when the repetition generation (F3) is “REPEAT” data, “RE
The generation rule from the start line to the end line of the appearance of “PEAT” is repeatedly executed until there is no table in the database 13 corresponding to the generation content (F1).

By executing the above processing until the end of the generation basic data (LST), a source program is generated using information in the database 13. FIG. 8 is a diagram showing basic data for generating a source program according to the present invention. The basic data includes a generation content (F1), a creation type (F2), and an iterative generation (F3).

FIG. 9 is a diagram showing an operation for creating a design document with a tag. This figure is a configuration for creating a design document, and shows a previous stage of the system shown in FIG. When creating a design document with a tag, an input screen (INP) having an input field for each item name is used, and a function name input field (F1) for each input field after completion of the item input
Then, the tag is automatically added by the tag adding device 20, for example, in the case of a tag <FUNCTION>, in the case of the function summary input field (F2), the tag <SUMARY>).

According to this embodiment, the user does not need to be aware of the tag for each item. In the block diagram shown in FIG. 1, a plurality of types of documents are input to the database 13, and information registered in one document is changed by another document.
Overwritable information (POS) is provided as a field constituting an information table in the database 13, and overwriting of information is permitted only for a specific document.

FIG. 10 is a diagram showing overwritable information.
For example, rewriting of interface information of a function is permitted by a design document, a source program, and a header file, but rewriting of information should not be permitted by a test procedure document which is a document for testing a program. In this case, the document type numbers of the design document, the source program, and the header file are set in the overwritable information (POS), and when the test procedure is input to the database 13, the test procedure document is included in the overwritable information. The item for which the document type is not set is not rewritten. 0 to the overwritable information (POS) part of the figure
Up to three pieces of information are written. In the case of the figure, 1, 2,
Since 3 has been written, overwriting is possible. If it is 0, overwriting is prohibited.

According to this embodiment, it is possible to prevent rewriting of documents other than the database 13 overwritable type information. As described above, according to this embodiment,
It is possible to improve the efficiency of creating a design document, a source program, a header file, and a test procedure manual in software development, and to prevent omission of a change between contents related to various software development documents.

In FIG. 1, since a plurality of types of documents are input to the database 13 and information registered in a certain document is changed by another document, it can be overwritten as a field constituting an information table in the database 13. Information (POS) can be provided to allow overwriting of information only to a specific document.

FIG. 11 is a diagram showing information setting document type information. The information table shown in the figure includes a function information link, a tag name, information, an information setting document type (KND), and a function name link or a link for a parameter. A numerical value from 0 to 3 is entered in the information setting document type among these, and it is determined whether or not to overwrite.

For example, rewriting of interface information of a function is permitted by a design document, a source program, and a header file, but rewriting of information should not be permitted by a test procedure document which is a document for testing a program. In this case, the overwriteable information (POS) includes
When the document type numbers of the design document, source program, and header file are set, and the test procedure is input to the database 13, the items for which the document type of the test procedure document is not set in the overwritable information are rewritten. Do not do. In the example of the figure, 3 is entered,
Allows overwriting.

FIG. 12 shows an information change confirmation display screen (DIS).
FIG. A confirmation screen image is displayed to prevent level down when overwriting information. The figure shows a state in which “int” as old information is changed to “char” as new information.

According to this embodiment, since the information of the design document, the source program, and the header file are overwritten on the same database, the development document having the old information is erroneously registered in the database, and The level of information can be prevented from being reduced.

The effects of the present invention described above will be described below.
According to the present invention, information is registered in the same database from various tagged documents having items whose information is related to each other, and when a document is required, the necessary document is generated from the database, thereby performing the operation on some documents. This eliminates problems that could lead to software development errors, such as omission of changes to other documents related to changes that have been made. In addition to the initial registration of design documents in the database, other than source documents, header files, test procedures, etc. Software development efficiency for automatically generating documents from a database can be improved.

[0049]

As described above in detail, according to the present invention, (1) a design document, a source program, a header file, and a test procedure document created in software development are tagged documents, and the same database is used. A document analysis registration unit that registers information for each tag item, a database that stores information for each tag, and a document generation unit that generates design documents, source programs, header files, and test procedure documents from the database. If the information is changed in any of the design document, source program, and header file after the initial creation of the design document and initial registration in the database, the information is registered in the same database, and the design document, source program Design documents in software development by automatically generating header files and test procedure documents In addition, it is possible to improve the efficiency of creating source programs, header files, and test procedure manuals, and to prevent omissions in changing related contents between various software development documents.

(2) In this case, when inputting information to the design document, an input field is provided for each input information on the input screen, and a tag is automatically added to the input information. This eliminates the need for the user to be aware of the tag for each item.

(3) Design documents, source programs,
The information in the header file is overwritten on the same database, and the overwriteable type information is added for each information item on the database so that the relevant information is not rewritten for documents other than the database overwriteable type information. can do.

(4) For each information item on the database, the corresponding information item is added with the development document type information that is set last, and if the registered content has a difference from the information on the database, it is set last. By displaying the type of development document and letting you decide whether to register the development document in the database,
Since the information of the source program and the header file is overwritten on the same database, it is possible to prevent the information on the database from being downgraded due to erroneous registration of a development document having old information in the database.

[Brief description of the drawings]

FIG. 1 is a principle block diagram of the present invention.

FIG. 2 is a diagram showing a configuration example of a tagged document of the present invention.

FIG. 3 is a flowchart showing a processing operation for creating analysis content information according to the present invention.

FIG. 4 is a diagram showing an example of a data format of analysis content information according to the present invention.

FIG. 5 is a flowchart showing a processing operation of registering information in a database according to the present invention.

FIG. 6 is a diagram showing an example of a data format in a database according to the present invention.

FIG. 7 is a flowchart showing a document generation processing operation according to the present invention.

FIG. 8 is a diagram showing basic data for generating a source program according to the present invention.

FIG. 9 is a diagram showing an operation for creating a design document with a tag.

FIG. 10 is a diagram showing overwritable information.

FIG. 11 is a diagram showing information setting document type information.

FIG. 12 is a diagram showing an information change confirmation display screen.

FIG. 13 is a conceptual diagram of a conventional document creation system.

FIG. 14 is a diagram illustrating a configuration example of a software development document.

[Explanation of symbols]

 DESCRIPTION OF SYMBOLS 1 Design document 2 Source program 3 Header file 4 Test procedure document 10 Multi-document generation device 11 Document analysis registration part 12 Analysis content information creation part 13 Database 14 Document generation part 15 Generation basic data file

Claims (4)

[Claims] 1. A document analysis and registration unit that registers a design document, a source program, a header file, and a test procedure document created in software development as a tagged document and registers information for each tag item in the same database; And a document generation unit that generates a design document, a source program, a header file, and a test procedure manual from the database. When information is changed in either the source program or the header file, the information is registered in the same database, and the design document, source program, header file, and test procedure manual are automatically generated when necessary. Automatic generation system. 2. The method according to claim 1, wherein, when inputting information to the design document, an input screen is provided with an input field for each input information, and a tag is automatically added to the input information. Automatic generation system of multiple documents described. 3. The method according to claim 1, wherein information of the design document, the source program, and the header file is overwritten on the same database, and overwriteable type information is added for each information item on the database. Automatic generation system. 4. The development document type information in which the information item corresponding to each information item in the database is added to the development document type information set last, and the content to be registered has a difference from the information in the database, the development document type set last. 2. The system for automatically generating a plurality of documents according to claim 1, further comprising the step of displaying whether or not to register the development document in the database.