CN115964079A - Automatic document generation method and system, electronic device and storage medium - Google Patents

Abstract

The application provides a document automatic generation method, a system, electronic equipment and a storage medium, which are used for reading a preset template document with a structured tag, generating a storage transition file with a tag key based on the tag name contained in the structured tag, generating a formatted output prompt based on the tag key, receiving custom content through the formatted output prompt and storing the custom content in the storage transition file, traversing the template document, writing the custom content into the corresponding structured tag, and generating a target document. By using the template document with the structured tag and generating the formatted output prompt according to the structured tag, a user can input required self-defined content, the automatic document generation method and the automatic document generation system can customize the content marked with the structured tag in the document according to the requirement of the user, and the generation requirements of various different types of documents can be met.

Description

Automatic document generation method and system, electronic device and storage medium

Technical Field

The present application relates to the field of document processing technologies, and in particular, to a method and a system for automatically generating a document, an electronic device, and a storage medium.

Background

Various documentation may be required during the software development process, such as requirements specification, software design specification, interface specification, test plans, test reports, and the like. The quality of the document can affect the completion progress and delivery quality of the subsequent project, and can also bring certain influence on the subsequent software design scheme and acceptance work. The large amount of document writing work consumes much time of developers, and the documents written manually have inevitable format and content errors.

Most current document automation generation methods generate a fixed type of document and require special code support. When the content and format of the document are modified or another document needs to be generated, the program development work is often required to be carried out again, and the reusability and the flexibility are poor. Chinese patent (publication No. CN 112257404A) discloses an automatic generation method and a generation device of a software requirement specification document based on QT 5. The method for automatically generating the requirement specification document based on QT5 software comprises the following steps of: step 1: designing an editing interface based on QT5 software; step 2: inputting a requirement label in the editing interface, and inputting corresponding requirement content in the corresponding requirement label; and step 3: and controlling Office software to automatically generate a requirement specification document meeting the requirements by using QT5 software. The method has the advantages that the idea of the required developers is released, the required developers do not need to care about the document standard and the format problem, only need to concentrate on the required development content, and the software document content conforming to the template or the standard can be generated in a one-key mode, so that the software development efficiency is greatly improved. The scheme only provides a method for generating the software requirement specification document, a specific program is used for generating a specific type of document, and the compatibility of the document with other types of documents is poor.

Disclosure of Invention

In view of the above drawbacks of the prior art, the present invention provides a method, a system, an electronic device, and a storage medium for automatically generating a document, so as to solve the technical problems of poor reusability and flexibility when automatically generating the document.

The application provides a document automatic generation method, which comprises the following steps:

reading a preset template document with a structured tag,

generating a storage transition file with tag keys based on tag names contained in the structured tags,

generating a formatted output prompt based on the tag key, receiving custom content via the formatted output prompt and storing in the storage transition file,

and traversing the template document, writing the self-defined content into the corresponding structured label, and generating a target document.

In an embodiment of the present invention, generating a storage transition file with a tag key based on a tag name included in the structured tag includes:

unloading each said tag name in said template document as said tag key in said storage transition file,

each of the tag keys has a corresponding value stored therein.

In an embodiment of the present invention, a formatted output prompt is generated based on the tag key, and receiving a custom content through the formatted output prompt and storing the custom content in the storage transition file includes:

generating a formatted output prompt based on the tag key, the formatted output prompt to receive the custom content,

and storing the self-defined content and the corresponding tag key into the storage transition file based on the received confirmation input signal.

In an embodiment of the present invention, the formatted output prompt includes a text edit box and a tab key description, the tab key description is used to prompt the tab key corresponding to the custom content to be input, and the text edit box is used to edit the custom content.

In an embodiment of the present invention, before reading the template document with the preset structured tag, the method further includes: and marking the template document by using the structured label based on the structured description part in the document.

In an embodiment of the present invention, traversing the template document, and writing the self-defined content into the corresponding structured tag includes:

traversing the structured label in the template document,

based on the tag name, looking up the corresponding tag key in the storage transition file,

and extracting the custom content corresponding to the tag key, and writing the custom content into the corresponding structured tag.

The application provides a document automatic generation system, including:

the template document reading module is used for reading the preset template document with the structured label;

a structured tag parsing and generating module, which generates the storage transition file with the tag key based on the tag name contained in the structured tag, generates the formatted output prompt based on the tag key, receives the self-defined content through the formatted output prompt and stores the self-defined content in the storage transition file,

and the document generating module is used for traversing the template document, writing the custom content into the corresponding structural label and generating the target document.

In an embodiment of the invention, the structural tag parsing and generating module further includes:

a storage file generating unit, for storing each label name in the template document as the label key in the storage transition file, wherein each label key stores a corresponding value,

a unit for receiving custom content, generating the formatted output prompt based on the tag key, the formatted output prompt for receiving the custom content,

and the custom content storage unit stores the custom content and the corresponding tag key into the storage transition file based on the received confirmation input signal.

The application provides an electronic device, including:

at least one processor; and

the memory stores instructions executable by the at least one processor to enable the at least one processor to perform the method of any one of claims 1 to 6.

The present application also provides a non-transitory computer readable storage medium having stored thereon computer instructions for causing the computer to perform the method as any one of the above.

The invention has the beneficial effects that: according to the document automatic generation method, the document automatic generation system, the electronic equipment and the storage medium, the template document with the structured tags is used, the formatted output prompt is generated according to the structured tags, a user can input required self-defined contents, the document automatic generation method and the document automatic generation system can customize the contents of the document with the structured tags according to the requirements of the user, the generation requirements of various documents of different types can be met, and the problem that the existing automatic document generation method is poor in reusability and flexibility is solved.

It is to be understood that both the foregoing general description and the following detailed description are exemplary and explanatory only and are not restrictive of the application.

Drawings

The accompanying drawings, which are incorporated in and constitute a part of this specification, illustrate embodiments consistent with the present application and together with the description, serve to explain the principles of the application. It is obvious that the drawings in the following description are only some embodiments of the application, and that for a person skilled in the art, other drawings can be derived from them without inventive effort. In the drawings:

FIG. 1 is a schematic flow diagram of an automatic document generation system shown in an exemplary embodiment of the present application;

FIG. 2 is an architecture diagram of an automated document generation system according to one embodiment provided herein;

FIG. 3 is an architecture diagram of a structured label parsing generation module according to an embodiment provided herein;

FIG. 4 illustrates a schematic structural diagram of a computer system suitable for use in implementing the electronic device of an embodiment of the present application.

Detailed Description

Other advantages and effects of the present invention will become apparent to those skilled in the art from the disclosure of the present specification, wherein the following description is made for the embodiments of the present invention with reference to the accompanying drawings and the preferred embodiments. The invention is capable of other and different embodiments and of being practiced or of being carried out in various ways, and its several details are capable of modification in various respects, all without departing from the spirit and scope of the present invention. It should be understood that the preferred embodiments are illustrative of the invention only and are not limiting upon the scope of the invention.

It should be noted that the drawings provided in the following embodiments are only for illustrating the basic idea of the present invention, and the components related to the present invention are only shown in the drawings rather than drawn according to the number, shape and size of the components in actual implementation, and the type, quantity and proportion of the components in actual implementation may be changed freely, and the layout of the components may be more complicated.

In the following description, numerous details are set forth to provide a more thorough explanation of embodiments of the present invention, however, it will be apparent to one skilled in the art that embodiments of the present invention may be practiced without these specific details, and in other embodiments, well-known structures and devices are shown in block diagram form, rather than in detail, to avoid obscuring embodiments of the present invention.

As shown in fig. 1, in an exemplary embodiment, there is also provided an automatic document generation method, which is described in detail as follows:

step S101: and reading a preset template document with a structured label.

In one embodiment of the present application, the programming is performed using Python language, and in other embodiments, the programming may also be performed using other programming languages such as C, C + +, and C #.

In an embodiment of the present application, the used content storage file is a JSON file, and in other embodiments, file storage tag names and custom contents in other formats may also be used.

The template document is used as a basis for generating a target document, the content of the template document is mainly divided into a generalized description part and a structured description part, the structured description part is used for filling in custom content, a structured tag is printed on the generalized description part, corresponding custom content is filled in the structured tag in the process of generating the target document, and therefore the target document required by a user is generated, and the generalized description part is a general part in the template document and cannot be changed in the process of generating the target document.

In an embodiment of the present application, the structured tag includes a tag name and a tag symbol, where the tag symbol is used to identify a start position and an end position of the structured tag, and therefore the tag symbol should appear in pairs, several commonly used tag symbols are provided in the present application and used to mark the structured tag in the template document, and the tag symbol is configured in the configuration table, and during the use process, the tag symbol may be modified, added, or deleted according to actual requirements, and several types of the structured tag are preset for the user to use, and if the tag symbol needs to be added or changed during the use process, the tag symbol may also be changed in the configuration file, where it should be noted that the tag symbol should select a symbol type that does not appear frequently in the document, and should appear in pairs, and a position where a user-defined content needs to be added can be marked obviously.

For example, the label symbols may be "{" and "}" appearing in pairs, the "{" being the starting point of the structured label notation, the "}" being the end point of the structured label, and the label name should be written between the "{" and "}", for example: "{ detailed scheme }", the label name of the structured label is known as "detailed scheme".

In an exemplary embodiment, step S101 further includes step S201 before reading a preset template document with a structured tag.

Step S201, based on the structural description part in the document, using the structural label as a mark to make a template document.

Illustratively, if the label symbols can be "[" and "]" appearing in pairs, in the structural description part of the template document, the label name "detailed scheme" is marked as "[ detailed scheme ]", "[" is the starting point of the structural label, "]" is the end point of the structural label, and the structural label "[ detailed scheme ]" marks the position of the label name "detailed scheme" in the template document.

Step S102: and generating a storage transition file with a label key based on the label name contained in the structured label.

In an exemplary embodiment, the step S102 of generating a storage transition file with tag keys based on the tag names contained in the structured tags further comprises the step S202.

Step S202, each label name in the template document is stored as a label key in the storage transition file, and each label key stores a corresponding value.

In one embodiment of the present application, the tag key and its corresponding value are stored in the transition file using the key-value pair, and the advantage of using the key-value pair for storage is that: the method has the advantages of high query speed, large data storage amount, high support of concurrency, suitability for query through the main key, null value stored in the tag key, and setting to other values according to actual requirements in other embodiments.

Illustratively, if the structured label is marked by using "[" and "]" appearing in pairs, the structured description part of the template document comprises a structured label of "[ detailed scheme ]", the label name is "detailed scheme", the generated content storage file stores the "detailed scheme" as a label key, the label key "detailed scheme" also stores preset values, and the "detailed scheme" is subsequently assigned with corresponding values.

Step S103: and generating a formatted output prompt based on the tag key, receiving the custom content through the formatted output prompt and storing the custom content in the storage transition file.

In an embodiment of the application, the formatted output prompt includes a text edit box and a tab key description, the tab key description is used for prompting a tab key corresponding to the custom content to be input, and the text edit box is used for editing the custom content. The formatted output prompt is displayed on the multimedia device, in other embodiments, the formatted output prompt can also be displayed on other devices which can be used for prompting and inputting, the formatted output prompt can be selected according to actual conditions, the formatted output prompt is used for prompting that user-defined content needs to be input, a text box is arranged in the formatted output prompt, the user-defined content can be input in the text box according to the requirement of a required document, the user-defined content can be stored at a corresponding label key of a content storage file, different user-defined contents can be stored into the value of the corresponding label key for subsequent calling and use, and in other embodiments, the user-defined content which needs to be input can also be received in other modes.

In an exemplary embodiment, step S103 generates a formatted output prompt based on the tab key, and receiving custom content via the formatted output prompt and storing in the storage transition file includes step S203.

And S203, generating a formatted output prompt based on the tag key, wherein the formatted output prompt is used for receiving the custom content, and storing the custom content and the corresponding tag key into a storage transition file based on the received confirmation input signal.

In an embodiment of the application, the user-defined content to be input is labeled through the label key stored in the content storage file, the user-defined content can be conveniently and sequentially extracted, the label key corresponding to the user-defined content is labeled on the formatted output prompt, based on the mutual matching of the label key and the label name, the setting can ensure that the input user-defined content is matched with the structured label, and the formatted output prompt is also provided with the setting for confirming the input of the user-defined content.

Step S104: and traversing the template document, writing the self-defined content into the corresponding structured tag, and generating the target document.

In one embodiment of the application, traversing the structured tags in the template document, writing the custom content corresponding to the structured tags into the structured tags, and generating the required target document, wherein the generalized description part remains unchanged in the target document, and the structured description part is filled with the custom content required by the user.

In an exemplary embodiment, step S104 traverses the template document, and writing the custom content at the corresponding structured tag includes step S204.

And step S204, traversing the structured tags in the template document, searching corresponding tag keys in the storage transition file based on the tag names, extracting the custom content corresponding to the tag keys, and writing the custom content into the corresponding structured tags.

In summary, according to the method and system for automatically generating a document provided by the present application, by using a template document with a structured tag and generating a formatted output prompt according to the structured tag, a user can input a desired user-defined content, so that the method and system for automatically generating a document can customize the content of the document where the structured tag is marked according to the user's needs, thereby being capable of meeting the generation requirements of documents of various types and solving the problem that the existing method for automatically generating a document has poor reusability and flexibility.

As shown in fig. 2, in an exemplary embodiment, there is also provided an automatic document generation system, which is described in detail as follows:

the template document reading module 201 reads a preset template document with a structured tag.

The structured tag parsing and generating module 202 generates a storage transition file with tag keys based on tag names included in the structured tags, generates a formatted output prompt based on the tag keys, receives custom content through the formatted output prompt, and stores the custom content in the storage transition file.

And the document generating module 203 traverses the template document, writes the self-defined content into the corresponding structured tag, and generates a target document.

Fig. 3 is an architecture diagram of a structured label parsing generation module according to an embodiment provided in the present application, as shown in fig. 3:

the storage file generating unit 301 dumps each tag name in the template document as a tag key in the storage transition file, where each tag key stores a corresponding value.

The receive custom content unit 302 generates a formatted output prompt based on the tab key, where the formatted output prompt is used to receive custom content.

The custom content storage unit 303 stores the custom content and the corresponding tag key in the storage transition file based on the received confirmation input signal.

An embodiment of the present application further provides an electronic device, including: one or more processors; and the storage device is used for storing one or more programs, and when the one or more programs are executed by one or more processors, the electronic equipment is enabled to realize the automatic document generation method provided in the various embodiments.

FIG. 4 illustrates a schematic structural diagram of a computer system suitable for use in implementing the electronic device of an embodiment of the present application. It should be noted that the computer system 1200 of the electronic device shown in fig. 4 is only an example, and should not bring any limitation to the functions and the scope of use of the embodiments of the present application.

As shown in fig. 4, the computer system 1200 includes a Central Processing Unit (CPU) 1201, which can perform various appropriate actions and processes, such as performing the methods described in the above embodiments, according to a program stored in a Read-Only Memory (ROM) 1202 or a program loaded from a storage section 1208 into a Random Access Memory (RAM) 1203. In the RAM 1203, various programs and data necessary for system operation are also stored. The CPU 1201, ROM 1202, and RAM 1203 are connected to each other by a bus 1204. An Input/Output (I/O) interface 1205 is also connected to bus 1204.

The following components are connected to the I/O interface 1205: an input section 1206 including a keyboard, a mouse, and the like; an output section 1207 including a Display device such as a Cathode Ray Tube (CRT), a Liquid Crystal Display (LCD), and a speaker; a storage section 1208 including a hard disk and the like; and a communication section 1209 including a Network interface card such as a LAN (Local Area Network) card, a modem, and the like. The communication section 1209 performs communication processing via a network such as the internet. A driver 1210 is also connected to the I/O interface 1205 as needed. A removable medium 1211, such as a magnetic disk, an optical disk, a magneto-optical disk, a semiconductor memory, or the like, is mounted on the drive 1210 as necessary, so that a computer program read out therefrom is mounted into the storage section 1208 as necessary.

In particular, according to embodiments of the present application, the processes described above with reference to the flow diagrams may be implemented as computer software programs. For example, embodiments of the present application include a computer program product comprising a computer program embodied on a computer readable medium, the computer program comprising a computer program for performing the method illustrated by the flow chart. In such an embodiment, the computer program can be downloaded and installed from a network through the communication portion 1209 and/or installed from the removable medium 1211. The computer program performs various functions defined in the system of the present application when executed by a Central Processing Unit (CPU) 1201.

It should be noted that the computer readable medium shown in the embodiments of the present application may be a computer readable signal medium or a computer readable storage medium or any combination of the two. The computer readable storage medium may be, for example, an electronic, magnetic, optical, electromagnetic, infrared, or semiconductor system, apparatus, or device, or any combination of the foregoing. More specific examples of the computer readable storage medium may include, but are not limited to: an electrical connection having one or more wires, a portable computer diskette, a hard disk, a Random Access Memory (RAM), a Read-Only Memory (ROM), an Erasable Programmable Read-Only Memory (EPROM), a flash Memory, an optical fiber, a portable Compact Disc Read-Only Memory (CD-ROM), an optical storage device, a magnetic storage device, or any suitable combination of the foregoing. In the present application, a computer-readable signal medium may comprise a propagated data signal with a computer-readable computer program embodied therein, either in baseband or as part of a carrier wave. Such a propagated data signal may take many forms, including, but not limited to, electro-magnetic, optical, or any suitable combination thereof. A computer readable signal medium may be any computer readable medium that is not a computer readable storage medium and that can communicate, propagate, or transport a program for use by or in connection with an instruction execution system, apparatus, or device. The computer program embodied on the computer readable medium may be transmitted using any appropriate medium, including but not limited to: wireless, wired, etc., or any suitable combination of the foregoing.

The flowchart and block diagrams in the figures illustrate the architecture, functionality, and operation of possible implementations of systems, methods and computer program products according to various embodiments of the present application. Each block in the flowchart or block diagrams may represent a module, segment, or portion of code, which comprises one or more executable instructions for implementing the specified logical function(s). It should also be noted that, in some alternative implementations, the functions noted in the block may occur out of the order noted in the figures. For example, two blocks shown in succession may, in fact, be executed substantially concurrently, or the blocks may sometimes be executed in the reverse order, depending upon the functionality involved. It will also be noted that each block of the block diagrams or flowchart illustration, and combinations of blocks in the block diagrams or flowchart illustration, can be implemented by special purpose hardware-based systems which perform the specified functions or acts, or combinations of special purpose hardware and computer instructions.

The units described in the embodiments of the present application may be implemented by software or hardware, and the described units may also be disposed in a processor. Wherein the names of the elements do not in some way constitute a limitation on the elements themselves.

Another aspect of the present application also provides a computer-readable storage medium having stored thereon a computer program which, when executed by a processor of a computer, causes the computer to execute the document automatic generation method as described above. The computer-readable storage medium may be included in the electronic device described in the above embodiment, or may exist separately without being incorporated in the electronic device.

Another aspect of the application also provides a computer program product or computer program comprising computer instructions stored in a computer readable storage medium. The processor of the computer device reads the computer instructions from the computer-readable storage medium, and the processor executes the computer instructions, so that the computer device executes the automatic document generation method provided in the above embodiments.

The foregoing embodiments are merely illustrative of the principles and utilities of the present invention and are not intended to limit the invention. Any person skilled in the art can modify or change the above-mentioned embodiments without departing from the spirit and scope of the present invention. Accordingly, it is intended that all equivalent modifications or changes which can be made by those skilled in the art without departing from the spirit and technical spirit of the present invention are covered by the claims of the present invention.

Claims (10)

1. An automatic document generation method is characterized by comprising the following steps:

reading a preset template document with a structured tag,

generating a storage transition file with tag keys based on tag names contained in the structured tags,

generating a formatted output prompt based on the tag key, receiving custom content via the formatted output prompt and storing in the storage transition file,

and traversing the template document, writing the self-defined content into the corresponding structured label, and generating a target document.

2. The method of claim 1, wherein generating a storage transition file with a tag key based on a tag name contained in the structured tag comprises:

unloading each said tag name in said template document as said tag key in said storage transition file,

each of the tag keys has a corresponding value stored therein.

3. The method of claim 1, wherein generating a formatted output prompt based on the tab key, receiving custom content via the formatted output prompt and storing in the storage transition file comprises:

generating a formatted output prompt based on the tag key, the formatted output prompt to receive the custom content,

and storing the self-defined content and the corresponding tag key into the storage transition file based on the received confirmation input signal.

4. The automatic document generation method according to claim 3, characterized in that: the formatted output prompt comprises a text edit box and a label key description, the label key description is used for prompting the label key corresponding to the custom content to be input, and the text edit box is used for editing the custom content.

5. The method for automatically generating a document according to claim 1, wherein reading the preset template document with the structured tag further comprises: and marking the template document by using the structured label based on the structured description part in the document.

6. The method for automatically generating a document according to claim 1, wherein traversing the template document and writing the custom content at the corresponding structural tag comprises:

traversing the structured label in the template document,

based on the tag name, looking up the corresponding tag key in the storage transition file,

and extracting the custom content corresponding to the tag key, and writing the custom content into the corresponding structured tag.

7. An automatic document generation system, comprising:

the template document reading module is used for reading the preset template document with the structured tag;

a structured tag parsing and generating module, which generates the storage transition file with the tag key based on the tag name contained in the structured tag, generates the formatted output prompt based on the tag key, receives the self-defined content through the formatted output prompt and stores the self-defined content in the storage transition file,

and the document generation module is used for traversing the template document, writing the self-defined content into the corresponding structured label and generating the target document.

8. The system of claim 7, wherein the structured tag parsing module further comprises:

a storage file generating unit, for storing each label name in the template document as the label key in the storage transition file, wherein each label key stores a corresponding value,

a unit for receiving custom content, generating the formatted output prompt based on the tag key, the formatted output prompt for receiving the custom content,

and the custom content storage unit stores the custom content and the corresponding tag key into the storage transition file based on the received confirmation input signal.

9. An electronic device, comprising:

at least one processor; and

the memory stores instructions executable by the at least one processor to enable the at least one processor to perform the method of any one of claims 1 to 6.

10. A non-transitory computer readable storage medium having stored thereon computer instructions for causing the computer to perform the method of any one of claims 1 to 6.

Images