CN114327435A - Technical document generation method and device and computer readable storage medium - Google Patents
Technical document generation method and device and computer readable storage medium Download PDFInfo
- Publication number
- CN114327435A CN114327435A CN202111632783.1A CN202111632783A CN114327435A CN 114327435 A CN114327435 A CN 114327435A CN 202111632783 A CN202111632783 A CN 202111632783A CN 114327435 A CN114327435 A CN 114327435A
- Authority
- CN
- China
- Prior art keywords
- technical document
- template file
- document generation
- position identification
- generation request
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
Images
Landscapes
- Information Retrieval, Db Structures And Fs Structures Therefor (AREA)
Abstract
The embodiment of the specification provides a technical document generation method, a technical document generation device and a computer-readable storage medium. The method comprises the steps of designing according to a document standard required by an enterprise to obtain a technical document template file, and generating a request by receiving a technical document aiming at a software code; acquiring data source information and a technical document template file based on a technical document generation request; matching the fields in the data source information with the position identification keys in the technical document template file; under the condition that the field is matched with the position identification key, replacing a key value corresponding to the position identification key by using the value of the field, and automatically generating a technical document of the software code; and a developer does not need to manually write technical documents, so that the workload of the developer is reduced.
Description
Technical Field
Embodiments of the present description relate to the field of computer technologies, and in particular, to a method and an apparatus for generating a technical document, a computer device, a computer-readable storage medium, and a computer program product.
Background
The software technical document is necessary data in the process of software development, use and maintenance. The method can improve the efficiency of software development, ensure the quality of software, and has the functions of guidance, help and confusion in the use process of the software, and particularly, documents are indispensable data in maintenance work.
In general, in the process of software project development, the design specification of the numerical control library and the sharing of the database relation design have high requirements. However, in the conventional art, this is achieved by writing a database design document by a developer himself, which greatly increases the workload of the developer.
Disclosure of Invention
In view of the above, embodiments of the present disclosure are directed to providing a method, an apparatus, a computer device, a computer-readable storage medium, and a computer program product for generating a technical document, so as to solve the technical problem that writing a technical document increases the workload of a developer in the conventional technology.
The embodiment of the specification provides a technical document generation method, which comprises the following steps: receiving a technical document generation request for software code; acquiring data source information and a technical document template file based on the technical document generation request; the data source information comprises fields and values of the fields; the technical document template file comprises a position identification key and a key value corresponding to the position identification key; matching the fields in the data source information with the position identification keys in the technical document template file; under the condition that the field is matched with the position identification key, replacing a key value corresponding to the position identification key by using the value of the field to generate a technical document of the software code; the technical document template file is designed according to document standards required by enterprises.
An embodiment of the present specification provides a technical document generation method, including: providing a technical document generation page; wherein the technical document generation page has a technical document generation control; under the condition that the technical document generation control is triggered, a technical document generation request aiming at the software code is sent to a server; the technical document generation request is used for indicating the server to read data source information based on the technical document generation request, matching fields of the data source information with position identification keys of a technical document template file, and under the condition that the fields are matched with the position identification keys, replacing key values corresponding to the position identification keys with values of the fields to generate a technical document of the software code; the technical document template file is designed according to document standards required by enterprises.
An embodiment of the present specification provides a technical document generation apparatus, including: the generation request receiving module is used for receiving a technical document generation request aiming at the software code; the information file acquisition module is used for acquiring data source information and a technical document template file based on the technical document generation request; the data source information comprises fields and values corresponding to the fields; the technical document template file comprises a position identification key and a key value corresponding to the position identification key; the field identification matching module is used for matching fields in the data source information with position identification keys in the technical document template file; a technical document generation module, configured to replace a key value corresponding to the location identifier key with a value of the field when the field is matched with the location identifier key, and generate a technical document of the software code; the technical document template file is designed according to document standards required by enterprises.
An embodiment of the present specification provides a technical document generation apparatus, including: generating a page providing page for providing a technical document generating page; wherein the technical document generation page has a technical document generation control; generating a request sending request, and sending a technical document generation request aiming at the software code to a server under the condition that the technical document generation control is triggered; the technical document generation request is used for indicating the server to read data source information based on the technical document generation request, matching fields of the data source information with position identification keys of a technical document template file, and under the condition that the fields are matched with the position identification keys, replacing key values corresponding to the position identification keys with values of the fields to generate a technical document of the software code; the technical document template file is designed according to document standards required by enterprises.
The present specification provides a computing device, comprising a memory and a processor, wherein the memory stores a computer program, and the processor implements the method steps of the above embodiments when executing the computer program.
The present specification provides a computer readable storage medium, on which a computer program is stored, which when executed by a processor implements the method steps in the above embodiments.
The present specification embodiments provide a computer program product, which includes instructions that, when executed by a processor of a computer device, enable the computer device to perform the method steps in the above embodiments.
In the implementation mode of the specification, a technical document template file is designed according to a document standard required by an enterprise, and a technical document generation request aiming at a software code is received; acquiring data source information and a technical document template file based on a technical document generation request; matching the fields in the data source information with the position identification keys in the technical document template file; under the condition that the field is matched with the position identification key, replacing a key value corresponding to the position identification key by using the value of the field, and automatically generating a technical document of the software code; and a developer does not need to manually write technical documents, so that the workload of the developer is reduced.
Drawings
FIG. 1 is a diagram illustrating an application environment of a method for generating a technical document according to an embodiment;
FIG. 2 is a flow diagram illustrating a method for generating a technical document according to an embodiment;
FIG. 3 is a flowchart illustrating a method for generating a technical document according to an embodiment;
FIG. 4 is a flowchart illustrating a method for generating a technical document according to an embodiment;
FIG. 5 is a block diagram of a technical document creation apparatus according to an embodiment;
FIG. 6 is a block diagram of a technical document creation apparatus according to an embodiment;
fig. 7 is an internal structural diagram of a computer device according to an embodiment.
Detailed Description
The technical solutions in the embodiments of the present disclosure will be clearly and completely described below with reference to the drawings in the embodiments of the present disclosure, and it is obvious that the described embodiments are only a part of the embodiments of the present disclosure, and not all of the embodiments. All other embodiments obtained by a person of ordinary skill in the art without any inventive work based on the embodiments in the present specification belong to the protection scope of the present specification.
Referring to fig. 1, the embodiment of the present specification provides a technical document generation system, and the technical document generation method provided by the present specification is applied to the technical document generation system. The technical document generation system may include a hardware environment formed by the terminal 110 and the server 120. The terminal 110 communicates with the server 120 through a network. The terminal 110 provides a technical document generation page; the technical document generation page is provided with a technical document generation control; in the case where the technical document generation control is triggered, the terminal 110 sends a technical document generation request for software code to the server. The server 120 reads data source information based on a technical document generation request, matches fields of the data source information with position identification keys of a technical document template file, and replaces key values corresponding to the position identification keys with values of the fields under the condition that the fields are matched with the position identification keys to generate a technical document of software codes; the technical document template file is designed according to document standards required by enterprises.
The terminal 110 may be, but is not limited to, various personal computers, notebook computers, smart phones, tablet computers, and portable wearable devices. The server 120 may be implemented as a stand-alone server or a server cluster composed of a plurality of servers. With the development of scientific technology, new computing devices, such as quantum computing servers, may be developed, and may also be applied to the embodiments of the present specification.
Referring to fig. 2, an embodiment of the present disclosure provides a technical document generation method applied to a server. The technical document generation method includes the following steps.
S210, receiving a technical document generation request aiming at the software code.
The technical document generation request may be a computer instruction sent by the terminal to the server for generating the technical document. The software code may be a complete program code corresponding to the software system, or may be a partial program code for realizing the functions of the unit. Specifically, the terminal is provided with a technical document generation page, and a technical document generation control is arranged in the technical document generation page. The terminal monitors the technical document generation control, and sends a technical document generation request aiming at the software code to the server under the condition that the technical document generation control is triggered. The server receives the technical document generation request.
S220, acquiring data source information and a technical document template file based on the technical document generation request.
The data source information comprises fields and values of the fields. The technical document template file comprises a position identification key and a key value corresponding to the position identification key. Specifically, the technical document generation request may be accompanied by address information pointing to the data source information. The data source information is obtained from the address information to which the technical document generation request points based on the technical document. In some implementations, the technical document template file may be a template file that provides the developer with the basic structure and basic content of the technical document. The server may store a technical document template set, where the technical document template set includes a plurality of template files. Firstly, data source information is acquired based on a technical document generation request; the data source information may then be used to match with attribute information of the template file. And if so, determining the technical document template file in the technical document template set according to the matching result.
In some embodiments, a technical document selection control is provided in the technical document generation page. In response to a triggering operation on the technical document selection control, a technical document template file for generating the technical document is determined. The technical document generation request carries a file identifier of the technical document template file, and the technical document template file is obtained based on the file identifier. In the embodiment, the matching degree between the technical document template file and the data source information is improved by specifying the technical document template file, so that the accuracy of the technical document is improved.
And S230, matching the field in the data source information with the position identification key in the technical document template file.
And S240, under the condition that the field is matched with the position identification key, replacing a key value corresponding to the position identification key by using the value of the field, and generating a technical document of the software code.
The technical document template file is a template file designed according to document standards required by enterprises. Specifically, in order to generate a technical document of software code, the acquired data source information needs to be filled into a technical document template file. The data source information includes fields and values of the fields. The technical document template file comprises a position identification key and a key value corresponding to the position identification key. The location identification key defines the location of each data element in the technical document template file. And matching the field in the data source information with the position identification key in the technical document template file, wherein if the field is matched with the position identification key in the technical document template file, the field value can be filled in the position of the position identification key in the technical document template file, so that under the condition that the field is matched with the position identification key, the field value is used for replacing the key value corresponding to the position identification key, and the technical document of the software code is generated.
The technical document generation method comprises the steps of designing according to document standards required by enterprises to obtain a technical document template file, and receiving a technical document generation request aiming at software codes; acquiring data source information and a technical document template file based on a technical document generation request; matching the fields in the data source information with the position identification keys in the technical document template file; under the condition that the field is matched with the position identification key, replacing a key value corresponding to the position identification key by using the value of the field, and automatically generating a technical document of the software code; and a developer does not need to manually write technical documents, so that the workload of the developer is reduced.
In some embodiments, the technical document generation request is accompanied by first descriptive text data. Each template file in the technical document template set corresponds to second descriptive text data. Referring to fig. 3, acquiring a technical document template file based on a technical document generation request includes:
s310, acquiring the embedded vector of the first descriptive text data and the embedded vector of any one of the second descriptive text data.
S320, under the condition that the embedded vector of the first descriptive text data is matched with the embedded vector of any one of the second descriptive text data, determining a template file corresponding to any one of the second descriptive text data in the technical document template set as a technical document template file.
Specifically, the server stores a technical document template set, and the technical document template set comprises a plurality of template files. Each template file has second descriptive text data for expressing the structure, function, and basic content of the template file. The server receives the first descriptive text data. The server may perform embedding processing on the first descriptive text data and the second descriptive text data, respectively, to obtain an embedded vector of the first descriptive text data and an embedded vector of the second descriptive text data.
In some embodiments, the second descriptive text data may be embedded in advance to obtain an embedded vector of the second descriptive text data and store the embedded vector. When the first descriptive text data is received, the embedded vector of the second descriptive text data can be directly obtained, the calculation amount of the server is reduced, and the generation speed of the technical document is improved.
In some embodiments, the similarity between the embedded vector of the first descriptive text data and any embedded vector of the second descriptive text data is calculated, the second descriptive text data with the similarity meeting a preset condition is obtained, and the template file corresponding to the second descriptive text data is used as the technical document template file. In some embodiments, the maximum similarity may be determined from the similarity between the embedded vector of the first descriptive text data and any embedded vector of the second descriptive text data, and the template file corresponding to the maximum similarity may be the technical document template file.
In the embodiment, the technical document template file is determined by the embedded vector of the first descriptive text data and the embedded vector of any one of the second descriptive text data, so that the operation cost of a user is reduced, and the accuracy of generating the technical document can be ensured.
In some embodiments, the technical document generation request is accompanied by a database link address. Wherein the database link address is used for establishing a communication connection with a target database associated with the software code. Acquiring data source information based on a technical document generation request, comprising: and analyzing the target database based on the database link address to obtain the table information, the field information and the index information of the target database. Wherein, the field information comprises fields and values corresponding to the fields; the field information, table information, and index information are used to populate the database document portion of the technical document template file.
Specifically, the terminal displays a database configuration page, and a database configuration control is provided in the database configuration page. And receiving the database configuration operation through the database configuration control, and responding to the database configuration operation, and displaying the identification information of the plurality of databases by the terminal. And taking the database corresponding to the selected identification information as a target database associated with the software code in a plurality of databases. And receiving an input database link address of the target database, and sending a technical document generation request aiming at the software code to the server, wherein the technical document generation request carries the database link address. And analyzing the target database based on the database link address to obtain the table information, the field information and the index information of the target database. And filling the field information, the table information and the index information into a database document part of the technical document template file.
In some embodiments, the field information includes fields and values corresponding to the fields.
In some embodiments, the terminal sends a technical document generation request for the software code to the server, wherein the technical document generation request carries the database link address. And the server carries out test linking on the basis of the database linking address, and if the test fails, an error message is returned to the terminal.
In the embodiment, the table information, the field information and the index information of the target database are obtained through analysis, the database document part of the technical document template file is generated, developers do not need to write the technical documents of the database, and the time of the developers is saved.
In some embodiments, the technical document generation request is accompanied by an interface description link address. And interface description data elements are stored in the webpage corresponding to the interface description link address. Acquiring data source information based on a technical document generation request, comprising: and acquiring interface description data elements from the webpage corresponding to the interface description link address. Wherein the interface description data element is used to fill in an interface document part of the technical document template file.
Specifically, the terminal may be provided with an input box of the interface description link address, receive the input interface description link address in the input box, access a webpage corresponding to the interface description link address, and obtain the interface description data element from the webpage. And writing the acquired interface description data element into an interface document part of the technical document template file. In some implementations, a document system swagger tool may be integrated. The method comprises the steps of receiving an input swagger address in an input box, obtaining a swagger description file, analyzing the swagger description file, obtaining interface description data elements and automatically generating an interface document part of a technical document template file. Swagger can be understood as a standard and complete framework for generating, describing, invoking and visualizing RESTful style Web services. The RESTful style is a software architecture style, design style, rather than a standard, but provides a set of design principles and constraints. The method is mainly used for the interactive software of the client and the server. Software designed based on the style can be simpler, more hierarchical and easier to realize mechanisms such as cache and the like.
In some implementations, the technical document template file includes an interface document portion and a database document portion. The order of the interface document portions may be located before the database document portions and the order of the interface document portions may be located after the database document portions. In some embodiments, the interface document portion of the technical document template file has interface unique identification information.
In the embodiment, the interface description data elements are acquired from the webpage corresponding to the interface description link address and are written into the interface document part of the technical document template file, so that developers do not need to write the interface document, and the time of the developers is saved.
In some embodiments, prior to matching with the location identification key in the technical document template file using the field in the data source information, the method further comprises: acquiring a file format of a technical document template file; calling a template engine corresponding to the file format; correspondingly, matching the field in the data source information with the position identification key in the technical document template file comprises the following steps: and matching the fields in the data source information with the position identification keys in the technical document template file based on the template engine.
Specifically, the file format may be WORD format, and may be EXCEL format. And acquiring the file format of the technical document template file in advance. Different file formats correspond to different template engines. And after the template engine is determined, calling the template engine corresponding to the file format, and writing the acquired data source information into the technical document template file. In some embodiments, if the WORD format is adopted, a template engine corresponding to the WORD format is called. In some embodiments, if the template is in the EXCEL format, the template engine corresponding to the EXCEL format is called.
In some embodiments, in order to generate the technical document of the software code, the acquired data source information needs to be filled into the technical document template file. The data source information includes fields and values of the fields. The technical document template file comprises a position identification key and a key value corresponding to the position identification key. And matching fields in the data source information with the position identification keys in the technical document template file. And under the condition that the field is matched with the position identification key, replacing a key value corresponding to the position identification key by using the value of the field to generate a technical document of the software code.
The technical document generation method comprises the following steps.
S402, receiving a technical document generation request aiming at the software code.
Wherein, the technical document generation request is attached with a database link address and an interface description link address. Interface description data elements are stored in the webpage corresponding to the interface description link address. The field information includes fields and values corresponding to the fields. The technical document generation request is attached with first description text data; each template file in the technical document template set corresponds to second descriptive text data.
S404, analyzing the target database based on the database link address to obtain table information, field information and index information of the target database.
S406, interface description data elements are obtained from the webpage corresponding to the interface description link address.
S408, acquiring the embedded vector of the first descriptive text data and the embedded vector of any second descriptive text data.
S410, under the condition that the embedded vector of the first descriptive text data is matched with the embedded vector of any one of the second descriptive text data, determining a template file corresponding to any one of the second descriptive text data in the technical document template set as a technical document template file.
Wherein the technical document template file comprises a database document part and an interface document part.
And S412, filling the interface description data elements into the interface document part of the technical document template file.
And S414, filling the field information, the table information and the index information into a database document part of the technical document template file.
Wherein, the field information comprises fields and values corresponding to the fields; in some embodiments, the technical document template file includes a location identification key and a key value corresponding to the location identification key. Under the condition that the field is matched with the position identification key, replacing a key value corresponding to the position identification key by using the value of the field to generate a technical document of the software code; the technical document template file is designed according to document standards required by enterprises.
Referring to fig. 4, an embodiment of the present disclosure provides a method for generating a technical document. The method is applied to the terminal. The technical document generation method may include the following steps.
S510, providing a technical document generation page.
Wherein the technical document generation page has a technical document generation control.
And S520, sending a technical document generation request aiming at the software code to the server under the condition that the technical document generation control is triggered.
The technical document generation request is used for indicating a server to read data source information based on the technical document generation request, matching fields of the data source information with position identification keys of a technical document template file, and replacing key values corresponding to the position identification keys with values of the fields under the condition that the fields are matched with the position identification keys to generate a technical document of software codes; the technical document template file is designed according to document standards required by enterprises.
In some implementations, prior to sending the technical document generation request for the software code to the server, the method further includes: displaying identification information of a plurality of databases under the condition of receiving database configuration operation; in a plurality of databases, taking the database corresponding to the selected identification information as a target database associated with the software code; accordingly, sending a technical document generation request for software code to a server, comprising: sending a database link address of the target database to the server; and the database link address is used for indicating the server to establish communication connection with the target database associated with the software codes.
In some embodiments, in the case that a link test operation for the target database is received, if it is detected that the communication connection with the target database cannot be performed, an error reminding message is displayed.
For specific limitations of the technical document generation method applied to the terminal, reference may be made to the above limitations of the technical document generation method, which are not described herein again.
It should be understood that, although the steps in the above-described flowcharts are shown in order as indicated by the arrows, the steps are not necessarily performed in order as indicated by the arrows. The steps are not performed in the exact order shown and described, and may be performed in other orders, unless explicitly stated otherwise. Moreover, at least a part of the steps in the above-mentioned flowcharts may include a plurality of steps or a plurality of stages, which are not necessarily performed at the same time, but may be performed at different times, and the order of performing the steps or the stages is not necessarily performed in sequence, but may be performed alternately or alternately with other steps or at least a part of the steps or the stages in other steps.
Referring to fig. 5, an embodiment of the present disclosure provides a technical document generating apparatus. The technical document generating device comprises a generating request receiving module, an information file obtaining module, a field identification matching module and a technical document generating module.
And the generation request receiving module is used for receiving a technical document generation request aiming at the software code.
The information file acquisition module is used for acquiring data source information and a technical document template file based on a technical document generation request; the data source information comprises fields and values corresponding to the fields; the technical document template file comprises a position identification key and a key value corresponding to the position identification key.
And the field identification matching module is used for matching the field in the data source information with the position identification key in the technical document template file.
The technical document generation module is used for replacing a key value corresponding to the position identification key by using a value of the field under the condition that the field is matched with the position identification key to generate a technical document of the software code; the technical document template file is designed according to document standards required by enterprises.
Referring to fig. 6, an embodiment of the present disclosure provides a technical document generating apparatus. The technical document generation device comprises a generation page providing module and a generation request sending module.
The generating page providing module is used for providing a technical document generating page; wherein the technical document generation page has a technical document generation control.
The generation request sending module is used for sending a technical document generation request aiming at the software code to the server under the condition that the technical document generation control is triggered; the technical document generation request is used for indicating a server to read data source information based on the technical document generation request, matching fields of the data source information with position identification keys of a technical document template file, and replacing key values corresponding to the position identification keys with values of the fields under the condition that the fields are matched with the position identification keys to generate a technical document of software codes; the technical document template file is designed according to document standards required by enterprises.
For specific limitations of the technical document generation apparatus, reference may be made to the above limitations of the technical document generation method, which are not described herein again. The respective modules in the technical document generation apparatus described above may be wholly or partially implemented by software, hardware, and a combination thereof. The modules can be embedded in a hardware form or independent from a processor in the computer device, and can also be stored in a memory in the computer device in a software form, so that the processor can call and execute operations corresponding to the modules.
In some embodiments, a computer device is provided, which may be a terminal, and its internal structure diagram may be as shown in fig. 7. The computer device includes a processor, a memory, a communication interface, a display screen, and an input device connected by a system bus. Wherein the processor of the computer device is configured to provide computing and control capabilities. The memory of the computer device comprises a nonvolatile storage medium and an internal memory. The non-volatile storage medium stores an operating system and a computer program. The internal memory provides an environment for the operation of an operating system and computer programs in the non-volatile storage medium. The communication interface of the computer device is used for carrying out wired or wireless communication with an external terminal, and the wireless communication can be realized through WIFI, an operator network, NFC (near field communication) or other technologies. The computer program is executed by a processor to implement a technical document generation method. The display screen of the computer equipment can be a liquid crystal display screen or an electronic ink display screen, and the input device of the computer equipment can be a touch layer covered on the display screen, a key, a track ball or a touch pad arranged on the shell of the computer equipment, an external keyboard, a touch pad or a mouse and the like.
Those skilled in the art will appreciate that the architecture shown in fig. 7 is merely a block diagram of some of the structures associated with the disclosed aspects and is not intended to limit the computing device to which the disclosed aspects apply, and that a computing device may in particular include more or less components than those shown, or combine certain components, or have a different arrangement of components.
In some embodiments, a computer device is provided, comprising a memory having a computer program stored therein and a processor that, when executing the computer program, performs the method steps of the above embodiments.
In some embodiments, a computer-readable storage medium is provided, on which a computer program is stored, which when executed by a processor implements the method steps in the above-described embodiments.
In some embodiments, a computer program product is also provided, which comprises instructions that are executable by a processor of a computer device to implement the method steps in the above-described embodiments.
It will be understood by those skilled in the art that all or part of the processes of the methods of the embodiments described above can be implemented by hardware instructions of a computer program, which can be stored in a non-volatile computer-readable storage medium, and when executed, can include the processes of the embodiments of the methods described above. Any reference to memory, storage, database, or other medium used in the various embodiments provided herein can include at least one of non-volatile and volatile memory. Non-volatile Memory may include Read-Only Memory (ROM), magnetic tape, floppy disk, flash Memory, optical storage, or the like. Volatile Memory can include Random Access Memory (RAM) or external cache Memory. By way of illustration and not limitation, RAM can take many forms, such as Static Random Access Memory (SRAM) or Dynamic Random Access Memory (DRAM), among others.
The features of the above embodiments may be arbitrarily combined, and for the sake of brevity, all possible combinations of the features in the above embodiments are not described, but should be construed as being within the scope of the present specification as long as there is no contradiction between the combinations of the features.
The above description is only for the purpose of illustrating the preferred embodiments of the present disclosure and is not to be construed as limiting the present disclosure, and any modifications, equivalents and the like that are within the spirit and principle of the present disclosure are intended to be included within the scope of the present disclosure.
Claims (10)
1. A technical document generation method, characterized in that the method comprises:
receiving a technical document generation request for software code;
acquiring data source information and a technical document template file based on the technical document generation request; the data source information comprises fields and values of the fields; the technical document template file comprises a position identification key and a key value corresponding to the position identification key;
matching the fields in the data source information with the position identification keys in the technical document template file;
under the condition that the field is matched with the position identification key, replacing a key value corresponding to the position identification key by using the value of the field to generate a technical document of the software code; the technical document template file is designed according to document standards required by enterprises.
2. The method according to claim 1, wherein the technical document generation request is accompanied by first descriptive text data; each template file in the technical document template set corresponds to second description text data; acquiring a technical document template file based on the technical document generation request, comprising:
acquiring an embedded vector of the first descriptive text data and an embedded vector of any second descriptive text data;
and determining a template file corresponding to any second descriptive text data in a technical document template set as the technical document template file under the condition that the embedded vector of the first descriptive text data is matched with the embedded vector of any second descriptive text data.
3. The method according to claim 1, wherein the technical document generation request is accompanied by a database link address; wherein the database link address is used for establishing communication connection with a target database associated with the software code; the obtaining of data source information based on the technical document generation request includes:
analyzing the target database based on the database link address to obtain table information, field information and index information of the target database; the field information comprises the field and a value corresponding to the field; the field information, the table information, and the index information are used to fill in a database document portion of the technical document template file.
4. A method according to claim 1 or 3, wherein the technical document generation request is accompanied by an interface description link address; interface description data elements are stored in a webpage corresponding to the interface description link address; the obtaining of data source information based on the technical document generation request includes:
acquiring the interface description data element from the webpage corresponding to the interface description link address; wherein the interface description data element is used to fill in an interface document part of the technical document template file.
5. The method of claim 1, wherein prior to said matching with a location identification key in the technical document template file using a field in the data source information, the method further comprises:
acquiring a file format of the technical document template file;
calling a template engine corresponding to the file format;
the matching between the fields in the data source information and the position identification keys in the technical document template file comprises the following steps:
and matching the fields in the data source information with the position identification keys in the technical document template file based on the template engine.
6. A technical document generation method, characterized in that the method comprises:
providing a technical document generation page; wherein the technical document generation page has a technical document generation control;
under the condition that the technical document generation control is triggered, a technical document generation request aiming at the software code is sent to a server; the technical document generation request is used for indicating the server to read data source information based on the technical document generation request, matching fields of the data source information with position identification keys of a technical document template file, and under the condition that the fields are matched with the position identification keys, replacing key values corresponding to the position identification keys with values of the fields to generate a technical document of the software code; the technical document template file is designed according to document standards required by enterprises.
7. The method of claim 6, wherein prior to said sending a technical document generation request for software code to a server, the method further comprises:
displaying identification information of a plurality of databases under the condition of receiving database configuration operation;
taking the database corresponding to the selected identification information as a target database associated with the software code in the plurality of databases;
the sending of the technical document generation request for the software code to the server comprises:
sending a database link address of the target database to a server; wherein the database link address is used to instruct the server to establish a communication connection with a target database associated with the software code.
8. A technical document generation apparatus, characterized in that the apparatus comprises:
the generation request receiving module is used for receiving a technical document generation request aiming at the software code;
the information file acquisition module is used for acquiring data source information and a technical document template file based on the technical document generation request; the data source information comprises fields and values corresponding to the fields; the technical document template file comprises a position identification key and a key value corresponding to the position identification key;
the field identification matching module is used for matching fields in the data source information with position identification keys in the technical document template file;
a technical document generation module, configured to replace a key value corresponding to the location identifier key with a value of the field when the field is matched with the location identifier key, and generate a technical document of the software code; the technical document template file is designed according to document standards required by enterprises.
9. A technical document generation apparatus, characterized in that the apparatus comprises:
the generating page providing module is used for providing a technical document generating page; wherein the technical document generation page has a technical document generation control;
the generation request sending module is used for sending a technical document generation request aiming at the software code to the server under the condition that the technical document generation control is triggered; the technical document generation request is used for indicating the server to read data source information based on the technical document generation request, matching fields of the data source information with position identification keys of a technical document template file, and under the condition that the fields are matched with the position identification keys, replacing key values corresponding to the position identification keys with values of the fields to generate a technical document of the software code; the technical document template file is designed according to document standards required by enterprises.
10. A computer-readable storage medium, on which a computer program is stored, which, when being executed by a processor, carries out the steps of the method of any one of claims 1 to 7.
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202111632783.1A CN114327435A (en) | 2021-12-28 | 2021-12-28 | Technical document generation method and device and computer readable storage medium |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202111632783.1A CN114327435A (en) | 2021-12-28 | 2021-12-28 | Technical document generation method and device and computer readable storage medium |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN114327435A true CN114327435A (en) | 2022-04-12 |
Family
ID=81014051
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202111632783.1A Pending CN114327435A (en) | 2021-12-28 | 2021-12-28 | Technical document generation method and device and computer readable storage medium |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN114327435A (en) |
-
2021
- 2021-12-28 CN CN202111632783.1A patent/CN114327435A/en active Pending
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN108446116B (en) | Application program page generation method and device, computer equipment and storage medium | |
| CN109901834B (en) | Document page generation method, device, computer equipment and storage medium | |
| WO2021217846A1 (en) | Interface data processing method and apparatus, and computer device and storage medium | |
| CN106648569B (en) | Target serialization realization method and device | |
| CN114115844A (en) | Page generation method and device, computer equipment and storage medium | |
| CN112306620B (en) | Multi-language loading method and device for user-defined form control | |
| CN114611481A (en) | Template configuration method and device, computer equipment and storage medium | |
| CN111596911A (en) | Method and device for generating control, computer equipment and storage medium | |
| CN111739136B (en) | Rendering method, computer device, and storage medium | |
| CN111427577A (en) | Code processing method and device and server | |
| CN115145545A (en) | Method and device for generating small program code, computer equipment and storage medium | |
| CN109542962B (en) | Data processing method, data processing device, computer equipment and storage medium | |
| CN110727777A (en) | Knowledge graph management method and device, computer equipment and storage medium | |
| CN110647350A (en) | Interface document generation method and device, computer equipment and storage medium | |
| CN114327435A (en) | Technical document generation method and device and computer readable storage medium | |
| CN115017436A (en) | Data interaction method and device of application program, computer equipment and storage medium | |
| CN113254455A (en) | Dynamic configuration method and device of database, computer equipment and storage medium | |
| CN114327611A (en) | Interface description document generation method and device, computer equipment and storage medium | |
| CN109871214B (en) | Program code generation method, program code generation device, computer device, and storage medium | |
| CN111597151A (en) | File generation method and device, computer equipment and storage medium | |
| CN112417020A (en) | Method and device for realizing service expansion, computer equipment and storage medium | |
| CN112835886A (en) | Data table field adding method and device | |
| CN110727481A (en) | Picture editing method and device, computer equipment and storage medium | |
| CN113656520B (en) | Spatial analysis method, spatial analysis device, computer equipment and storage medium | |
| CN114296714A (en) | Program code generation method, program code generation device, computer device, and storage medium |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication | ||
| SE01 | Entry into force of request for substantive examination | ||
| SE01 | Entry into force of request for substantive examination |