Method for Automatically Generating Software Description Documents

An automated method for generating software description documents for complex automotive embedded control systems addresses inefficiencies by organizing and standardizing documentation, ensuring consistency and improving automation efficiency.

CN117610496BActive Publication Date: 2024-12-03DONGFENG COMML VEHICLE CO LTD
View PDF 0 Cites 0 Cited by

Patent Information

Application Number
CN202311529344.7
Authority / Receiving Office
CN · China
Patent Type
Patents(China)
Current Assignee / Owner
Filing Date
2023-11-14
Publication Date
2024-12-03
Estimated Expiration
2043-11-14

AI Technical Summary

Technical Problem

Existing software development documentation for complex automotive embedded control systems is inefficient due to manual creation, lack of standardization, and varied presentation formats, making it difficult to find specific details and maintain consistency.

Method used

An automated method for generating software description documents by obtaining functional models, determining sub-functional units, numbering module names and images, and combining them hierarchically, with data dictionary information and change records, ensuring consistency with the software's structural framework.

Benefits of technology

Improves data organization and integrity, enhances automation efficiency, and ensures the generated documents are consistent with the software's structural framework, facilitating easy consultation and reducing manual effort.

✦ Generated by Eureka AI based on patent content.

Smart Images

  • Figure CN117610496B_ABST
    Figure CN117610496B_ABST
Patent Text Reader

Abstract

This application discloses an automatic software documentation generation method. This method studies the software's functional model as a whole, which not only improves the data's organization but also ensures its integrity. Furthermore, the explanatory text for each sub-functional unit of the model can be obtained according to design needs. Finally, by using the design framework as the skeleton structure of the software documentation and adaptively filling in the skeleton structure based on the obtained explanatory text, the software documentation is obtained. This method effectively utilizes the design framework of the functional model in the software development process, ensuring that the software documentation is completely consistent with the software's structural framework and maintaining the organization of the software documentation. Moreover, because this method can automatically generate software documentation based on existing data, it greatly improves the automation efficiency of obtaining software documentation.
Need to check novelty before this filing date? Find Prior Art

Description

Technical Field

[0001] The present invention relates to the technical field of embedded system control software, and in particular to a method for automatically generating software description documents. Background Art

[0002] Software development documentation is an important tool for software development, use and maintenance. Especially for complex automotive embedded control software, software calibration engineers need to refer to the software development documentation written by software development engineers to carry out calibration work. Software development documentation usually needs to elaborate on the hierarchical relationship between the functional modules of the software, express the functions and logic of each module in a hierarchical manner, and explain the input, output, and important intermediate variables.

[0003] At present, in order to obtain software development documents, software development engineers usually spend a lot of time manually writing, sorting and typesetting, which is very inefficient. In addition, since there is no specific standard for the format of software descriptions, the presentation effects of software development documents are varied, which is not convenient for targeted reading, especially during use, it is difficult to find a specific detail description.

[0004] Therefore, in the process of making software description documents in the prior art, there are problems such as low organization and low automation due to the low standardization of the documents. Summary of the invention

[0005] In view of this, it is necessary to provide a method for automatically generating software description documents to solve the problems of low organization and low automation level in the process of making software description documents in the prior art due to low document standardization.

[0006] In order to solve the above problems, the present invention provides a method for automatically generating a software description document, comprising:

[0007] Obtain multiple functional models of the software, and determine the sub-functional unit modules of each level in the functional model based on the design framework of the functional model;

[0008] Obtain the module name, logical strategy model image and description text of each sub-functional unit module at each level;

[0009] According to the design framework, the module names, logical strategy model images and description texts are numbered hierarchically to obtain the functional model description document;

[0010] A plurality of functional model description documents are sorted and combined to obtain a software description document.

[0011] Furthermore, the functional model description document includes data dictionary information of the functional model, and the data dictionary information includes variable classification and specific data types of the variables;

[0012] Among them, the variable classification includes at least input variables, output variables, constants, calibration variables and intermediate variables;

[0013] The specific data type of a variable includes at least the variable name, data type, dimension, unit, initial value and interpretation information.

[0014] Furthermore, the description text of each sub-functional unit module at each level is obtained, including:

[0015] Obtaining a variable classification of a functional model based on a first preset script;

[0016] Acquire specific data types of variables in the data dictionary information of the functional model based on the second preset script;

[0017] Sort the variable categories according to the preset rules, and fill the specific data type description of the variable into the corresponding position to obtain the explanatory text.

[0018] Furthermore, the variable classification is sorted according to the preset rules, and the specific data type description of the variable is filled into the corresponding position to obtain the description text, including:

[0019] According to the variable classification, build a data dictionary description table, use the variable classification as the title, classify and organize the specific data types of the variables, and obtain the description text.

[0020] Furthermore, according to the design framework, the module names, logical strategy model images and description texts are numbered in a hierarchical relationship to obtain a functional model description document, including:

[0021] Determine the module name number of the module name, the image number of the logic strategy model image, and the description text number of the description text according to the design framework;

[0022] Sort the module names, logical strategy model pictures and description texts according to the module name numbers, picture numbers and description text numbers to obtain the functional model description document;

[0023] Among them, the sub-module name is set as the corresponding hierarchical title of the functional model description document.

[0024] Furthermore, after the module name, the logical strategy model image and the description text are sorted according to the module name number, the image number and the description text number to obtain the functional model description document, the following is further included:

[0025] By using the image and text separation technology, the logical strategy model image of the description document is separated from the text to obtain an updated image;

[0026] Among them, the text in the updated image can be edited and retrieved independently.

[0027] Furthermore, the description document also includes a data dictionary description list; after the module name, the logic strategy model picture and the description text are sorted according to the module name number, the picture number and the description text number, the functional model description document is obtained, and further includes:

[0028] Get the title text of each level corresponding to each sub-functional unit module at each level;

[0029] Through link generation technology, the title texts at each level are automatically linked to obtain interrelated title texts;

[0030] Get the variable name of the data dictionary description list;

[0031] Through the link generation technology, the variable names in the description document are automatically linked to obtain interrelated variable names.

[0032] Furthermore, the description document also includes a change record table; after obtaining the software description document, it also includes:

[0033] Obtain the change information of the description document and build a change record table based on the change information.

[0034] Furthermore, after obtaining the software description document, it also includes:

[0035] Set text format standards and revise the format of instruction documents based on the text format standards.

[0036] Furthermore, after sorting and combining the multiple description documents of the multiple function models to obtain the software description document, the method further includes:

[0037] Merging the software description document into the software description document library to obtain an updated software description document library;

[0038] Updating the directory of the updated software description document library to obtain a new directory of the updated software description document library;

[0039] Generate a new search index based on the updated software description document library;

[0040] Among them, the new search index includes all the text of the software documentation.

[0041] The beneficial effects of adopting the above technical scheme are as follows: the present invention provides a method for automatically generating software description documents, which not only improves the orderliness of data but also ensures data integrity by studying the functional model of the software as a whole; in addition, the description text of each sub-functional unit of the model can be obtained according to design needs; finally, by taking the design framework as the skeleton structure of the software description document and adaptively filling the skeleton structure according to the obtained description text, the software description document is obtained, which can effectively utilize the design framework of the functional model in the software development process, ensure that the software description document is completely consistent with the structural framework of the software, ensure the orderliness of the software description document, and because the method can automatically generate the software description document according to the existing data, the automation efficiency of obtaining the software description document is greatly improved. BRIEF DESCRIPTION OF THE DRAWINGS

[0042] Figure 1 A schematic diagram of a flow chart of an embodiment of a method for automatically generating a software description document provided by the present invention;

[0043] Figure 2 A schematic diagram of the structure of an embodiment of the design framework provided by the present invention;

[0044] Figure 3 A schematic diagram of the structure of an embodiment of a design framework with node numbers provided by the present invention;

[0045] Figure 4 A schematic diagram of a flow chart of an embodiment of obtaining the description text of each sub-functional unit module at each level provided by the present invention;

[0046] Figure 5 A schematic diagram of a flow chart of a first embodiment of obtaining a functional model description document provided by the present invention;

[0047] Figure 6 A schematic diagram of a flow chart of a second embodiment of obtaining a functional model description document provided by the present invention;

[0048] Figure 7 A schematic diagram of a flow chart of an embodiment of obtaining a software description document provided by the present invention;

[0049] Figure 8 A schematic diagram of the structure of an embodiment of a device for automatically generating software description documents provided by the present invention;

[0050] Fig. 9 This is a structural block diagram of an embodiment of an electronic device provided by the present invention. DETAILED DESCRIPTION

[0051] The preferred embodiments of the present invention are described in detail below in conjunction with the accompanying drawings, wherein the accompanying drawings constitute a part of this application and are used together with the embodiments of the present invention to illustrate the principles of the present invention, but are not used to limit the scope of the present invention.

[0052] Before describing the implementation example, let's first explain the Simulink simulation technology:

[0053] Simulink simulation technology is a visual simulation tool that can be used for dynamic system modeling and simulation. It provides a graphical editor, a customizable module library, and a solver to simulate and debug the system.

[0054] Software development documentation is an important tool for software development, use and maintenance. Especially for complex automotive embedded control software, software calibration engineers need to refer to the software development documentation written by software development engineers to carry out calibration work. Software development documentation usually needs to elaborate on the hierarchical relationship between the functional modules of the software, express the functions and logic of each module in a hierarchical manner, and explain the input, output, and important intermediate variables.

[0055] At present, in order to obtain software development documents, software development engineers usually spend a lot of time manually writing, sorting and typesetting, which is very inefficient. In addition, since there is no specific standard for the format of software descriptions, the presentation effects of software development documents are varied, which is not convenient for targeted reading, especially during use, it is difficult to find a specific detail description.

[0056] Therefore, in the process of making software description documents in the prior art, there are problems such as low organization and low automation due to the low standardization of the documents.

[0057] In order to solve the above problems, the present invention provides a method for automatically generating a software description document, which is described in detail below.

[0058] like Figure 1 As shown, Figure 1 A flowchart of an embodiment of a method for automatically generating a software description document provided by the present invention includes:

[0059] Step S101: obtaining multiple functional models of the software, and determining each sub-functional unit module at each level in the functional model based on the design framework of the functional model;

[0060] Step S102: Obtain the module name, logic strategy model image and description text of each sub-functional unit module at each level;

[0061] Step S103: numbering the module names, logical strategy model images and description texts according to the hierarchical relationship according to the design framework to obtain a functional model description document;

[0062] Step S104: sort and combine multiple function model description documents to obtain a software description document.

[0063] In this embodiment, first, multiple functional models of the software are obtained, and the modules of each sub-functional unit at each level in the functional model are determined based on the design framework of the functional model; secondly, the module names, logical strategy model images and explanatory texts of each sub-functional unit module at each level are obtained; then, the module names, logical strategy model images and explanatory texts are numbered according to the hierarchical relationship based on the design framework to obtain a functional model description document; finally, multiple functional model description documents are sorted and combined to obtain a software description document.

[0064] In this embodiment, by studying the functional model of the software as a whole, not only the orderliness of the data is improved, but also the data integrity is guaranteed; in addition, the description text of each sub-functional unit of the model can be obtained according to the design needs; finally, by taking the design framework as the skeleton structure of the software description document, and adaptively filling the skeleton structure according to the obtained description text, and then obtaining the software description document, the design framework of the functional model in the software development process can be effectively utilized to ensure that the software description document is completely consistent with the structural framework of the software and the orderliness of the software description document is guaranteed. Moreover, since this method can automatically generate the software description document based on the existing data, the automation efficiency of obtaining the software description document is greatly improved.

[0065] It should be noted that, in a specific embodiment, in order to enrich the presentation form of the description document and display the connection between various parts as much as possible in a limited display area, the software description document is presented in the form of: a logical node connection diagram with node interpretations, wherein each node of the logical node connection diagram corresponds to a functional model or a sub-functional unit of the software; in addition, the connection line between the nodes represents the relationship between the two nodes, which can be an inclusion relationship, such as: the previous node represents the functional model, and the next node represents the sub-functional unit; it can also be an explanatory relationship, such as: the previous node represents the sub-functional unit, and the next node represents the explanatory text corresponding to the sub-functional unit.

[0066] In other embodiments, the node connection relationship of the software description document can also be adaptively adjusted according to actual needs, such as: cross connection, replaceable relationship, etc. according to actual needs.

[0067] As a preferred embodiment, in step S101, by dividing the software into functional models, the software is divided into multiple relatively independent and complete parts, which can improve the subsequent pertinence of the functional models.

[0068] In a specific embodiment, the design framework of the functional model is in a tree form. Figure 2As shown, Figure 2 This is a structural diagram of an embodiment of the design framework provided by the present invention. It should be noted that, in this embodiment, the design framework is adaptively labeled only according to the architecture construction situation in the design stage, so as to determine the basic structural information of each design framework of the functional model, thereby ensuring the accuracy of subsequent information matching. However, since the designer's job is the design itself, the subsequent supplementary explanation work is done by other personnel, and thus the design framework does not include detailed text information.

[0069] Due to the complexity of the design framework itself, the nodes in the design framework include layer nodes and level nodes; the functional model includes first-layer sub-functional units and second-layer sub-functional units; the node numbering includes layer node numbers and level node numbers; in order to facilitate the subsequent correspondence with the explanatory text, it is also necessary to number the multiple nodes in the design framework to obtain a design framework with node numbers for the functional model.

[0070] To clearly illustrate the effect of the design framework with node numbers, e.g. Figure 3 As shown, Figure 3 A structural schematic diagram of an embodiment of a design framework with node numbering provided by the present invention, wherein A represents a layer node, A1, A2 and A3 respectively represent the three level nodes of A, and the connecting lines represent the relationship between the layer node A and A1, A2 and A3 respectively.

[0071] In this embodiment, nodes in the design framework are layered to obtain multiple layers of nodes, and the relationship between two adjacent layers of nodes can be determined by numbering each layer of nodes, so that users can understand the relationship therein.

[0072] In a specific embodiment, A represents a functional model having function A, and A1 represents a sub-functional unit module of A.

[0073] In another specific embodiment, A represents a sub-functional unit module having function A, and A1 represents a sub-functional unit module at a next level of A, which will not be described in detail herein.

[0074] Obviously, according to Figure 3 It can be seen that each node in the design framework with node numbers has a unique number.

[0075] In a specific embodiment, the level nodes corresponding to the nodes of the same layer are sorted in ascending order to determine the level node numbers.

[0076] Specifically, in Figure 3On this basis, the parameters of the third-layer sub-functional units are sorted and numbered according to A1.1, A1.2, A1.3, A2.1, A2.2, A3.1, and so on, so as to obtain the complete node numbering of the design framework of the functional model.

[0077] In other specific embodiments, the sorting may be performed in other orders, which are not limited here.

[0078] In this embodiment, since the design framework of each functional model of the software is uniquely determined during the design process, data division is performed based on the design framework of the functional model, thereby avoiding the problem of disorder in the data combing process due to possible data intersection. In addition, each functional model of the software is studied as a whole, which effectively ensures data integrity while improving the orderliness of the data sorting process.

[0079] As a preferred embodiment, in order to facilitate data classification and sorting in the subsequent data processing process, the content of the function model description document is first described, the function model description document includes data dictionary information of the function model, and the data dictionary information includes variable classification and specific data types of the variables;

[0080] Among them, the variable classification includes at least input variables, output variables, constants, calibration variables and intermediate variables;

[0081] The specific data type of a variable includes at least the variable name, data type, dimension, unit, initial value and interpretation information.

[0082] As a preferred embodiment, in step S102, each sub-functional unit module at each level of the functional model also includes a specific module name, a logical strategy model image and an explanatory text to highlight the characteristics of each sub-functional unit module at each level.

[0083] Furthermore, in order to obtain the description text of each sub-functional unit module at each level, such as Figure 4 As shown, Figure 4 A flowchart of an embodiment of obtaining the description text of each sub-functional unit module at each level provided by the present invention includes:

[0084] Step S121: obtaining variable classification of the functional model based on the first preset script;

[0085] Step S122: acquiring specific data types of variables in the data dictionary information of the function model based on the second preset script;

[0086] Step S123: Sort the variable categories according to preset rules, and fill the variable specific data type description into the corresponding position to obtain the description text.

[0087] In this embodiment, first, the variable classification of the functional model is obtained based on the first preset script; and the specific data type of the variable in the data dictionary information of the functional model is obtained based on the second preset script; then, the variable classification is sorted according to the preset rules, and the specific data type description of the variable is filled into the corresponding position to obtain the explanatory text.

[0088] In a specific embodiment, the function model is simulated using Simulink simulation technology, so as to obtain the variable classification of the function model and the specific data types of the variables in the data dictionary information in a targeted manner.

[0089] As a preferred embodiment, in step S123, after obtaining the variable classification of the functional model and the specific data types of the variables in the data dictionary information, due to the lack of special data combing, data disorder may occur. Therefore, according to the variable classification, a data dictionary description table is built, with the variable classification as the title, and the specific data types of the variables are classified and sorted to obtain a description text.

[0090] As a preferred embodiment, in step S103, in order to obtain a functional model description document, such as Figure 5 As shown, Figure 5 The flowchart of the first embodiment of obtaining the functional model description document provided by the present invention includes:

[0091] Step S131: Determine the module name number of the module name, the image number of the logic strategy model image, and the description text number of the description text according to the design framework;

[0092] Step S132: Sort the module names, logical strategy model pictures and description texts according to the module name numbers, picture numbers and description text numbers to obtain a functional model description document;

[0093] Among them, the sub-module name is set as the corresponding hierarchical title of the functional model description document.

[0094] In this embodiment, first, the module name number of the module name, the image number of the logical strategy model image, and the description text number of the description text are determined respectively according to the design framework; then, the module name, logical strategy model image, and description text are sorted according to the module name number, image number, and description text number to obtain the functional model description document.

[0095] In this embodiment, based on the hierarchical relationship of the design framework itself, according to the numbering sequence of each sub-functional unit module at each level, the module name number of the module name, the picture number of the logical strategy model picture and the description text number of the description text corresponding to each sub-functional unit module at each level are determined, thereby achieving that for each module name, logical strategy model picture and description text in each sub-functional unit module, there is a unique number corresponding to it, thereby ensuring the accuracy of the module name, logical strategy model picture and description text; after obtaining the number, the module name, logical strategy model picture and description text are sorted according to the module name number, picture number and description text number, thereby obtaining a functional model description document, which can ensure the integrity of the data and avoid omissions.

[0096] In a specific embodiment, for each module name, logical strategy model image and explanatory text of the sub-functional unit module, in order to facilitate the user to understand the meaning during use, special explanations are required, and for the convenience of reference, they need to be numbered, such as module name 1.1, logical strategy model image 1.1.1, specific data 1.1.2. That is to say, through numbering, it is possible to determine the association between any specific data and the sub-functional unit module according to the data number, and even determine the location of the data in the functional model description document.

[0097] In a specific embodiment, the data of the same sub-functional unit module are sorted in ascending order to determine the specific serial number of the data.

[0098] In other embodiments, the sorting may be performed in descending order or in other rules, which are not limited here.

[0099] As a preferred embodiment, in step S104, after obtaining each functional model description document, in order to ensure the orderliness of the software description document, it is necessary to sort and combine the functional model description documents, so as to adaptively combine the functional models studied as a whole to obtain the software description document.

[0100] Based on the above method, a software description document with detailed data description can be obtained, which is easy to consult and well organized. By taking the design framework as the skeleton structure of the software description document and adaptively filling the skeleton structure according to the obtained functional model description text, the software description document can be obtained. The design framework of the functional model in the software development process can be effectively utilized to ensure that the software description document is completely consistent with the structural framework of the software and the orderliness of the software description document is ensured. In addition, since this method can automatically generate software description documents based on existing data, the automation efficiency of obtaining software description documents is greatly improved.

[0101] However, since the functional model description documents obtained above will contain some data information in the form of pictures, in order to facilitate finding comprehensive content and avoid omissions in the subsequent use of the software description documents, it is also necessary to use picture-text separation technology to separate the pictures in the description documents into text and obtain updated pictures and picture interpretation texts.

[0102] In a specific embodiment, the image and text separation technology includes but is not limited to the use of Vb language or matlab and Microsoft Word interface commands, which can decompose the image object in the rtf format file into multiple text and image objects, and the text objects therein are selectable and editable.

[0103] In this embodiment, by performing targeted processing on the image, the convenience of subsequent use of the instruction text can be improved.

[0104] Furthermore, since there are more or less similar or even identical parts in the same software, in order to improve the relevance of the variables in the functional model description document, the functional model description document also includes a data dictionary description list; Figure 6 As shown, Figure 6 The flowchart of the second embodiment of obtaining the functional model description document provided by the present invention includes:

[0105] Step S231: Obtaining the title text of each level corresponding to each sub-functional unit module of each level;

[0106] Step S232: automatically linking the title texts at each level using link generation technology to obtain interrelated title texts;

[0107] Step S233: Obtain the variable names of the data dictionary description list;

[0108] Step S234: Automatically link the variable names in the description document using link generation technology to obtain interrelated variable names.

[0109] In this embodiment, first, the title texts of each level corresponding to each sub-functional unit module of each level are obtained; then, the title texts of each level are automatically linked through the link generation technology to obtain the mutually related title texts; next, the variable names of the data dictionary description list are obtained; finally, the variable names in the description document are automatically linked through the link generation technology to obtain the mutually related variable names.

[0110] In this embodiment, in order to facilitate the user to understand all the information of the same data when using the software description document, a one-key association operation is specially performed for the data in the data dictionary description list.

[0111] That is to say, in this embodiment, all key text information is specifically associated through link generation technology, so that users can easily understand all information corresponding to any key text information during use, thereby helping users to quickly become familiar with the software.

[0112] In a specific embodiment, in order to obtain a data dictionary description list, part of the variable data in the software description document may be specifically extracted according to actual needs.

[0113] In another specific embodiment, in order to simplify the operation, the parameters in the data dictionary description list can also be traversed, that is, for each parameter appearing in the data dictionary description list, a one-key association operation will be performed.

[0114] In a specific embodiment, the variable name information in the software description document is automatically linked through link generation technology. For example, when the variable name AAA appears in both the parameter type and specific data of the software description document, an interactive link is automatically established, thereby realizing rapid switching of the variable name AAA to different locations for easy searching.

[0115] Furthermore, the description document also includes a change record table; the software will be updated to a greater or lesser extent during its operation. The more frequently used software is, the shorter its update cycle is. In order to avoid the problem of data mismatch due to untimely updates, the change information of the description document is specifically obtained, and a change record table is constructed based on the change information. This allows users to determine the meaning of a certain information in the corresponding description document based on the current version and update record, thereby avoiding confusion.

[0116] In a specific embodiment, the change log table can also be monitored in real time. When the change information of the instruction document is obtained, the current electronic version of the instruction document is adaptively updated and the update status is marked in the change log table accordingly to facilitate users to find the modified parts.

[0117] Specifically, when there is a request to change the background (such as improving a control strategy to solve a market problem), the change person, the change content, the change time and other information, the description needs to be updated in text. In the process of generating a new description document, the latest change requirement is used as the final version, and it is automatically updated in the document accordingly, and the change history record in the change record table is automatically added and updated.

[0118] Furthermore, in order to beautify the output form of the software description document and facilitate user reference, after obtaining the software description document, it is also necessary to adaptively control the font and layout of the software description document text information, set text format standards, and revise the format of the description document based on the text format standards, so as to improve the readability of the software description document.

[0119] Furthermore, for the automatically generated software description documents, due to the requirements of information security or authority such as confidentiality of key technologies, that is, part of the content of the design framework of the functional model needs to be adaptively hidden. In order to avoid numbering errors and omissions in the automatically generated description documents, after obtaining the automatically generated initial software description document, it is also necessary to specifically re-sort and reconstruct the title number hierarchy in the initial software description document to ensure that it is arranged correctly in order according to the hierarchy.

[0120] Furthermore, in order to improve the relevance between various functional models, for each functional model, a special document merging operation is performed to enable one-click retrieval of text descriptions of all functional models.

[0121] As a preferred embodiment, after obtaining the software description document, in order to automatically update the software description document library according to the newly obtained software description document, as shown in FIG. Figure 7 As shown, Figure 7 A flowchart of an embodiment of obtaining a software description document provided by the present invention includes:

[0122] Step S141: merging the software description document into the software description document library to obtain an updated software description document library;

[0123] Step S142: updating the directory of the updated software description document library to obtain a new directory of the updated software description document library;

[0124] Step S143: generating a new search index based on the updated software description document library;

[0125] Among them, the new search index includes all the text of the software documentation.

[0126] In this embodiment, first, the software description document is merged into the software description document library to obtain an updated software description document library; then, the directory of the updated software description document library is updated to obtain a new directory of the updated software description document library; finally, a new search index is generated based on the updated software description document library.

[0127] In this embodiment, the software description document is added to the software description document library in real time to achieve real-time updating of the software description document library, and the directory is updated in real time based on the updated software description document library, so that users can use the updated software description document library to view documents; a new retrieval index is generated based on the updated software description document library, which can ensure the integrity of the index and avoid data omissions.

[0128] Through the above method, for the overall software system, an overall software development text library can be formed. The software development text library is composed of the description texts of multiple sub-functional units, each description text corresponds to a sub-functional unit, and the overall software development text library has a unified directory management, and the fields in each text in the text library can be uniformly searched; for each newly developed or updated model-based software module, according to a specific description text paradigm, the model layer is automatically expanded layer by layer, and a title is generated corresponding to the model level. The title corresponds to the name of the subsystem module of this layer, and a model picture and corresponding model description text are added under the title, and a key variable list description is automatically added according to a specific format, and the variable name in the key variable list description is automatically linked to the field where the variable name appears in the picture and description text in the text, and the text level title is automatically linked to the corresponding subsystem module name field, and text modification history information is automatically added, and font and typesetting processing are unified. Finally, the newly generated functional unit is incorporated into the software description text library, the total text library directory is automatically updated, and all text content in the new text, including the text content in the picture, is made fully searchable in the total text library.

[0129] Through the above method, by studying the functional model of the software as a whole, not only the orderliness of the data is improved, but also the data integrity is guaranteed; in addition, the description text of each sub-functional unit of the model can be obtained according to the design needs; finally, by taking the design framework as the skeleton structure of the software description document, and adaptively filling the skeleton structure according to the obtained description text, and then obtaining the software description document, it is possible to effectively utilize the design framework of the functional model in the software development process, ensure that the software description document is completely consistent with the structural framework of the software, and ensure the orderliness of the software description document, and because this method can automatically generate software description documents based on existing data, it greatly improves the automation efficiency of obtaining software description documents.

[0130] In order to solve the above problems, the present invention also provides a software description document automatic generation device, such as Figure 8 As shown, Figure 8 The schematic diagram of the structure of an embodiment of the automatic software description document generation device provided by the present invention is as follows. The automatic software description document generation device 800 includes:

[0131] The sub-functional unit module determination component 801 is used to obtain multiple functional models of the software and determine the sub-functional unit modules of each level in the functional model based on the design framework of the functional model;

[0132] The data acquisition component 802 is used to obtain the module name, logic strategy model image and description text of each sub-functional unit module at each level;

[0133] Functional model description document determination component 803, used to number the module name, logic strategy model image and description text according to the hierarchical relationship according to the design framework to obtain the functional model description document;

[0134] The description document generation component 804 is used to sort and combine multiple function model description documents to obtain a software description document.

[0135] The present invention also provides an electronic device, such as Fig. 9 As shown, Fig. 9 This is a structural block diagram of an embodiment of an electronic device provided by the present invention. The electronic device 900 may be a computing device such as a mobile terminal, a desktop computer, a notebook, a PDA, and a server. The electronic device 900 includes a processor 901, a memory 902, and a display 903, wherein the memory 902 stores a software description document automatic generation program.

[0136] In some embodiments, the memory 902 may be an internal storage unit of a computer device, such as a hard disk or memory of the computer device. In other embodiments, the memory 902 may also be an external storage device of the computer device, such as a plug-in hard disk, a smart memory card (Smart Media Card, SMC), a secure digital (SecureDigital, SD) card, a flash card (Flash Card), etc. equipped on the computer device. Further, the memory 902 may also include both an internal storage unit of the computer device and an external storage device. The memory 902 is used to store application software and various types of data installed in the computer device, such as program codes for installing the computer device. The memory 902 may also be used to temporarily store data that has been output or is to be output. In one embodiment, the software description document automatic generation program may be executed by the processor 901, thereby realizing the software description document automatic generation method of each embodiment of the present invention.

[0137] In some embodiments, the processor 901 may be a central processing unit (CPU), a microprocessor or other data processing chip, used to run program codes or process data stored in the memory 902, such as executing a software description document automatic generation program.

[0138] In some embodiments, the display 903 may be an LED display, a liquid crystal display, a touch-sensitive liquid crystal display, an OLED (Organic Light-Emitting Diode) touch device, etc. The display 903 is used to display information on the electronic device 900 and to display a visual user interface. The components 901-903 of the electronic device 900 communicate with each other via a system bus.

[0139] This embodiment also provides a computer-readable storage medium, on which a software description document automatic generation program is stored. When the program is executed by a processor of a computer, the software description document automatic generation method as described in any of the above technical solutions is implemented.

[0140] Those skilled in the art can understand that all or part of the processes in the above-mentioned embodiment methods can be completed by instructing the relevant hardware through a computer program, and the computer program can be stored in a non-volatile computer-readable storage medium. When the computer program is executed, it can include the processes of the embodiments of the above-mentioned methods. Any reference to memory, storage, database or other storage medium used in the embodiments provided in this application may include non-volatile and / or volatile memory. Non-volatile memory may include read-only memory (ROM), programmable ROM (PROM), electrically programmable ROM (EPROM), electrically erasable programmable ROM (EEPROM) or flash memory. Volatile memory may include random access memory (RAM) or external cache memory. As an illustration and not limitation, RAM is available in many forms, such as static RAM (SRAM), dynamic RAM (DRAM), synchronous DRAM (SDRAM), double data rate SDRAM (DDRSDRAM), enhanced SDRAM (ESDRAM), synchronous link (Synchlink) DRAM (SLDRAM), memory bus (Rambus) direct RAM (RDRAM), direct memory bus dynamic RAM (DRDRAM), and memory bus dynamic RAM (RDRAM).

[0141] The above description is only a preferred specific implementation manner of the present invention, but the protection scope of the present invention is not limited thereto. Any changes or substitutions that can be easily conceived by any technician familiar with the technical field within the technical scope disclosed by the present invention should be covered within the protection scope of the present invention.

Claims

1. A method for automatically generating software description documents, characterized in that: include: Acquire multiple functional models of the software, and determine each sub-functional unit module of each level in the functional model based on the design framework of the functional model, wherein the functional model description document includes data dictionary information of the functional model, and the data dictionary information includes variable classification and specific data type of the variable; Obtain the module name, logic strategy model image and description text of each sub-functional unit module at each level; According to the design framework, the module name, the logic strategy model image and the description text are numbered in a hierarchical relationship to obtain a functional model description document; Sorting and combining the plurality of function model description documents to obtain a software description document; The obtaining of the description text of each sub-functional unit module at each level includes: Acquire the variable classification of the functional model based on a first preset script; Acquire the specific data type of the variable in the data dictionary information of the functional model based on a second preset script; The variable categories are sorted according to preset rules, and the specific data type descriptions of the variables are filled into corresponding positions to obtain the description text.

2. The method for automatically generating software description documents according to claim 1, characterized in that: The variable classification includes at least input variables, output variables, constants, calibration variables and intermediate variables; The specific data type of the variable includes at least the variable name, data type, dimension, unit, initial value and interpretation information.

3. The method for automatically generating software description documents according to claim 1, characterized in that: The variable classification is sorted according to the preset rules, and the specific data type description of the variable is filled into the corresponding position to obtain the description text, including: According to the variable classification, a data dictionary description table is constructed, and the variable classification is used as a title to classify and organize the specific data types of the variables to obtain the description text.

4. The method for automatically generating software description documents according to claim 1, characterized in that: The module name, the logic strategy model image and the description text are numbered according to the hierarchical relationship according to the design framework to obtain a functional model description document, including: Determine the module name number of the module name, the picture number of the logic strategy model picture and the description text number of the description text respectively according to the design framework; Sort the module name, the logic strategy model picture and the description text according to the module name number, the picture number and the description text number to obtain the function model description document; Among them, the sub-module name is set as the corresponding hierarchical title of the functional model description document.

5. The method for automatically generating software description documents according to claim 4, characterized in that: After the module name, the logic strategy model picture and the description text are sorted according to the module name number, the picture number and the description text number to obtain the function model description document, the method further includes: By using the image and text separation technology, the image and text of the logic strategy model image of the description document are separated to obtain an updated image; The text in the updated image can be edited and retrieved independently.

6. The method for automatically generating software description documents according to claim 5, characterized in that: The description document further includes a data dictionary description list; after the module name, the logic strategy model picture and the description text are sorted according to the module name number, the picture number and the description text number to obtain the function model description document, the following further includes: Obtaining title texts of each level corresponding to each sub-functional unit module of each level; Through the link generation technology, the title texts of each level are automatically linked to obtain mutually related title texts; Get the variable name of the data dictionary description list; By using the link generation technology, the variable names in the description document are automatically linked to obtain interrelated variable names.

7. The method for automatically generating software description documents according to claim 6, characterized in that: The instruction document also includes a change record table; After obtaining the software description document, it also includes: The change information of the description document is obtained, and the change record table is constructed according to the change information.

8. The method for automatically generating software description documents according to claim 7, characterized in that: After obtaining the software description document, it also includes: A text format standard is set, and the format of the instruction document is revised based on the text format standard.

9. The method for automatically generating software description documents according to claim 8, characterized in that: After the plurality of description documents of the plurality of function models are sorted and combined to obtain the software description document, the method further comprises: Merging the software description document into a software description document library to obtain an updated software description document library; Updating the directory of the updated software description document library to obtain a new directory of the updated software description document library; Generate a new search index based on the updated software description document library; Wherein, the new search index includes all the texts in the software description document.