CN107729047B

CN107729047B - Document generation method and device

Info

Publication number: CN107729047B
Application number: CN201710943649.0A
Authority: CN
Inventors: 郑德辉
Original assignee: Ruijie Networks Co Ltd
Current assignee: Ruijie Networks Co Ltd
Priority date: 2017-10-11
Filing date: 2017-10-11
Publication date: 2020-08-25
Anticipated expiration: 2037-10-11
Also published as: CN107729047A

Abstract

The embodiment of the application provides a document generation method and device. The document generation method comprises the following steps: determining a target product needing to generate a document and a target document type needing to be generated; selecting a configuration macro contained in the target product from a configuration macro set according to the configuration macro file of the target product; selecting reference data matched with the configuration macro contained in the target product from a reference data set corresponding to the target document type; and generating a document required by the target product according to the reference data matched with the configuration macro contained in the target product. By adopting the method and the device, the documents required by the product can be automatically generated, the efficiency is high, and the error probability of the documents is favorably reduced.

Description

Document generation method and device

Technical Field

The present application relates to the field of communications technologies, and in particular, to a method and an apparatus for generating a document.

Background

In the fields of internet, communication and the like, relevant documents are generally published simultaneously when hardware products or software products are published. These documents help users to understand information about the product, such as product function, method of use, configuration guides or system logs, etc.

In the prior art, developers compile related documents which need to be issued simultaneously with products, the compilers submit test personnel to test after compiling, and the documents are submitted to the testers for rechecking and acceptance after the test is passed, and finally the documents are issued together with the products. The document issuing mode has low efficiency, and the error rate of the document is relatively high because the number of documents is large as the product is frequently updated and updated.

Disclosure of Invention

Aspects of the present disclosure provide a document generating method and device, so as to improve document generating efficiency and reduce a document error rate.

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

determining a target product needing to generate a document and a target document type needing to be generated;

selecting a configuration macro contained in the target product from a configuration macro set according to the configuration macro file of the target product;

selecting reference data matched with the configuration macro contained in the target product from a reference data set corresponding to the target document type;

and generating a document required by the target product according to the reference data matched with the configuration macro contained in the target product.

In an optional embodiment, the determining a target product of the document to be generated and a target document type to be generated includes:

according to an access request of a user, a plurality of label pages are displayed to the user, and each label page corresponds to one document type;

responding to the operation that the user selects a target tab page from the plurality of tab pages, and determining that the document type corresponding to the target tab page is the target document type; and

displaying a product list on the target tab page for the user to select the target product from;

and responding to the operation that the user selects the target product from the product list, and determining the target product.

In an alternative embodiment, the target tab page includes a document export control;

the displaying a product list on the target tab page includes:

and responding to the operation of clicking the document export control by the user, and displaying the product list on the target label page.

In an optional embodiment, the selecting, from the reference data set corresponding to the target document type, reference data that matches a configuration macro included in the target product includes:

exporting all the reference data in the reference data set to a list type file;

adding a selected mark or an unselected mark to each datum data in the list-type file according to the matching condition of the configuration macro contained in the target product and the datum data;

from the list-type file, reference data with a selected marker is selected.

In an optional implementation manner, the generating a document required by the target product according to the benchmark data matched with the configuration macro included in the target product includes:

acquiring a document template corresponding to the target document type;

and adding reference data matched with the configuration macro contained in the target product into the document template to obtain a document required by the target product.

In an optional embodiment, before selecting the configuration macro contained in the target product from the configuration macro set according to the configuration macro file of the target product, the method further includes:

updating the configuration macro set incrementally according to configuration macros included in a new product whenever the new product appears; and/or

And updating the configuration macro set in an incremental mode according to the user-defined configuration macro every time the user defines the configuration macro by user self.

In an optional implementation manner, before selecting, from the reference data set corresponding to the target document type, reference data matching the configuration macro included in the target product, the method further includes:

updating the reference data set in an incremental manner according to the reference data which is related to the new product and corresponds to the target document type when the new product appears; and/or

And updating the reference data set in an incremental mode according to the reference data which is customized by the user and corresponds to the target document type every time the user customizes the reference data which corresponds to the target document type.

An embodiment of the present application further provides a document generating apparatus, including:

the determining module is used for determining a target product needing to generate a document and a target document type needing to be generated;

the first selection module is used for selecting the configuration macro contained in the target product from the configuration macro set according to the configuration macro file of the target product;

the second selection module is used for selecting reference data matched with the configuration macro contained in the target product from a reference data set corresponding to the target document type;

and the generating module is used for generating a document required by the target product according to the reference data matched with the configuration macro contained in the target product.

An embodiment of the present application further provides an electronic device, including: a memory and a processor;

the memory is used for storing programs;

the processor to execute the program in the memory to:

In the embodiment of the application, firstly, a target product needing to generate a document and a target document type needing to be generated are determined; and selecting the configuration macro contained in the target product from the configuration macro set based on the configuration macro file of the target product, further selecting reference data matched with the configuration macro contained in the target product from the reference data set corresponding to the target document type, and generating a document required by the target product according to the selected reference data. Therefore, the method and the device for generating the document can automatically generate the document required by the product based on the configuration macro file of the product and the matching relation between the configuration macro and the reference data, not only is the efficiency high, but also the error probability of the document is favorably reduced.

Drawings

The accompanying drawings, which are included to provide a further understanding of the application and are incorporated in and constitute a part of this application, illustrate embodiment(s) of the application and together with the description serve to explain the application and not to limit the application. In the drawings:

FIG. 1a is a flowchart illustrating a document generating method according to an embodiment of the present application;

FIG. 1b is a state diagram illustrating the selection of baseline data via a list-type file according to another embodiment of the present application;

FIG. 2 is a flowchart illustrating a document generation method according to another embodiment of the present application;

FIG. 3a is a flowchart illustrating a document generation method according to another embodiment of the present application;

FIG. 3b is a partially schematic illustration of a CREF document provided in yet another embodiment of the present application;

FIG. 4a is a flowchart illustrating a document generation method according to another embodiment of the present application;

FIG. 4b is a partial schematic diagram of an SCG document provided in accordance with yet another embodiment of the present application;

FIG. 5 is a schematic structural diagram of a document generating apparatus according to another embodiment of the present application;

fig. 6 is a schematic structural diagram of an electronic device according to yet another embodiment of the present application.

Detailed Description

In order to make the objects, technical solutions and advantages of the present application more apparent, the technical solutions of the present application will be described in detail and completely with reference to the following specific embodiments of the present application and the accompanying drawings. It should be apparent that the described embodiments are only some of the embodiments of the present application, and not all of the embodiments. All other embodiments, which can be derived by a person skilled in the art from the embodiments given herein without making any creative effort, shall fall within the protection scope of the present application.

Fig. 1a is a schematic flowchart of a document generating method according to an embodiment of the present application. As shown in fig. 1a, the method comprises:

101. and determining a target product needing to generate the document and a target document type needing to be generated.

102. And selecting the configuration macro contained in the target product from the configuration macro set according to the configuration macro file of the target product.

103. And selecting reference data matched with the configuration macro contained in the target product from the reference data set corresponding to the target document type.

104. And generating a document required by the target product according to the reference data matched with the configuration macro contained in the target product.

In practical applications, according to different application scenarios or application requirements, corresponding documents are often generated for products. For example, when a product is published, a document published along with the product needs to be generated for the product. For example, when authenticating a product, there is a need to generate an authentication document that can assist in authenticating the product. These documents are based on products. The documents to be generated will vary from product to product.

In addition, there may be multiple types of documents associated with a product. Generally, the type of document to be generated may vary according to the product, application requirements, or application scenario. Taking products in the communication field as an example, the documents generally include several types of documents such as a Software product function Specification (SPEC) document, a Command Reference (CREF) document, a product Configuration Guide (SCG) document, a Management Information Base (MIB) document, a System Log (SYSLOG) document, and a Software Requirement Specification (SRS) document.

In the present embodiment, a document generating apparatus is provided, which may be, for example, but is not limited to, a configuration macro definition management document system. When a document needs to be generated, a document generation apparatus first determines a product that needs to generate the document and a type of the document that needs to be generated. For convenience of description and distinction, a product requiring generation of a document is set as a target product, and accordingly, a document type requiring generation is set as a target document type.

The present embodiment does not limit the type or form of the target product. For example, the target product may be a software-based product or a hardware-based product in the fields of internet, communication, and the like. The software product may be some Application programs (apps), plug-ins, patches, and the like. The hardware products can be switches, routers or wireless access devices.

In the product development process, some common or general functions may be encapsulated as a configuration macro in order to improve portability and readability of product code. A configuration macro is another name for "macro definition" that represents a piece of function code by a macro name. For example, the macro name of the configuration macro is AAA, and represents a piece of functional code for implementing flow control. For another example, the macro name of the configuration macro is ABB, which represents a piece of function code that can split a 40G interface into 4 10G interfaces. For another example, the macro of the configuration macro is named BBB, and represents a piece of functional code for implementing cable detection. For another example, the macro of the configuration macro is named BBC, and represents a segment of function code for implementing optical module anti-counterfeiting. For another example, the macro name of the configuration macro is BCC, which represents a section of function code for reporting the interface statistics of the Access Point (AP) to the wireless Controller (AC).

In the present embodiment, the document generating apparatus stores in advance a configuration macro set storing various types of configuration macros. The configuration macros stored in the configuration macro set may vary according to the application environment. In the case of application scenario determination, theoretically, all configuration macros in the application scenario may be included in the configuration macro set. For example, assuming that the application scenario is a company, the configuration macros related to all products of the company may be included in the configuration macro set, which is the most complete set of configuration macros.

For a specific product, the configuration macro used by the product can be managed through the configuration macro file. The configuration macro file comprises a switch of the configuration macro, and the switch is used for controlling the on or off of the configuration macro. For example, AAA ═ Y is defined in the configuration macro file, indicating that the configuration macro AAA is on, BBC ═ N is defined, indicating that the configuration macro BBC is not on (off), ABB ═ Y is defined, indicating that the configuration macro ABB is on, and so on. The functions of different products are different, the used configuration macros are also different, and the switching conditions of the configuration macros defined in the configuration macro file are also different. It should be noted that the values used for controlling the configuration macro to turn on or off in the configuration macro file are not limited to "Y" and "N," and may be other values such as "1" and "0.

In this embodiment, after the target product is determined, the configuration macro contained in the target product may be selected from the configuration macro set according to the configuration macro file of the target product. For example, assuming that the configuration macro defined as "Y" in the configuration macro file is the configuration macro that the target product needs to be opened, the configuration macro defined as "Y" in the configuration macro file may be selected from the configuration macro set as the configuration macro included in the target product.

In addition, each document type has its own reference data. For any document type, the reference data refers to the smallest data unit forming the document of the type, and each document is formed by a series of reference data. For any document type, its reference data may form a reference data set. Different document types correspond to different sets of reference data. For a document of either type, the document is typically composed of portions of the reference data in the corresponding reference data set, which may be considered a subset of the reference data set. For example, for a target document type, each document of that type is generally made up of portions of the reference data in the reference data set to which that document type corresponds.

The reference data and the configuration macro have a one-to-one correspondence relationship. The benchmark data under different document types is responsible for describing, explaining, defining or describing the configuration macro under the corresponding document type according to the corresponding document type.

In the present embodiment, the document generating apparatus stores reference data sets corresponding to respective document types in advance. After the configuration macro contained in the target product is determined, the reference data matched with the configuration macro contained in the target product can be selected from the reference data set corresponding to the target document type; further, a document necessary for the target product is generated based on the reference data matched with the placement macro included in the target product.

As can be seen from the above analysis, in this embodiment, based on the configuration macro set and the reference data set, based on the configuration macro file of the target product and the matching relationship between the configuration macro and the reference data, a required document can be automatically generated for the product, which is not only efficient, but also beneficial to reducing the error probability of the document.

In the above embodiment or the following embodiments, the target product and the target document type need to be determined. Optionally, in an exemplary embodiment of determining the target product and the target document type, the document generation apparatus distinguishes different document types by different tab pages, each tab page corresponds to one document type, and provides the user with access addresses of a plurality of tab pages for the user to select the target document type. Based on this, the user can request access to a plurality of tab pages through the access address. When the user issues an access request through the access address, the document generation apparatus may present a plurality of tab pages to the user according to the access request of the user. After seeing the plurality of tab pages, the user can select a required target tab page, and the target tab page corresponds to the target document type. Based on the above, the document generation device may determine that the document type corresponding to the target tab page is the target document type in response to an operation of the user selecting the target tab page from the plurality of tab pages; displaying a product list on the target label page for the user to select a target product; and further responding to the operation that the user selects the target product from the product list, and determining the target product.

In an implementation manner, the tab pages may be implemented as web pages, and then the tab pages may be pushed to a browser on the user side, and the tab pages are displayed to the user through the browser.

In another implementation manner, the multiple tab pages may be implemented as pages of a client, and then the multiple tab pages may be pushed to the client on the user side, and the multiple tab pages are displayed to the user through the client.

In the above process, when responding to the operation of selecting the target tab page by the user, on one hand, the target document type can be determined, on the other hand, the target tab page needs to be displayed to the user, and the product list is displayed on the target tab page. The product list displays product information supporting generation of a target document type, so that a user can select a target product from the product information. The user may select one product or a plurality of products from the product list, i.e. the target product may be one or a plurality of products.

In one exemplary implementation, the product list may be embedded in the target tab page as the content of the target tab page, such that the product list is presented to the user while the target tab page is presented.

In another exemplary implementation, the product list is independent of the target tab page. And a document export control is included on the target label page, so that a user can trigger a document export operation. Based on this, the user can click on the document export control, and then in response to the user's operation of clicking on the document export control, a product list is presented on the target tab page. The product list can be directly displayed on the target label page, or can be displayed on the target label page through a floating layer or a small window.

In the above embodiment or the following embodiments, it is necessary to select, from the reference data set corresponding to the target document type, reference data that matches the configuration macro included in the target product. An exemplary embodiment of matching reference data includes: exporting all the reference data in the reference data set corresponding to the target document type to a list type file, such as an Excel file; then, adding a selected mark or an unselected mark to each datum data in the list-type file according to the matching condition of the configuration macro contained in the target product and the datum data; for the reference data matching with the configuration macro contained in the target product, adding a selected mark, such as the 'V' shown in FIG. 1 b; adding an unselected mark to the reference data which is not matched with the configuration macro contained in the target product, wherein the unselected mark is 'x' shown in FIG. 1 b; after adding a selected mark or an unselected mark to each reference data, the reference data with the selected mark is selected from the list-type file. By means of the method, the process of selecting the datum data can be visualized, or the result of selecting the datum data can be visualized, so that file personnel can conveniently check whether the selection result of the datum data is correct or not, the datum data can be corrected or the macro can be configured, and the accuracy of the file can be further improved.

It should be noted that, ideally, there is a one-to-one correspondence between the reference data and the configuration macro, but there may be some special cases that may result in an incomplete match between the reference data and the configuration macro. For example, situations where the baseline data describes inaccuracies or the configuration macro is wrongly written, etc., may result in an incomplete match between the baseline data and the configuration macro. In these cases, it is not possible to simply add a selected or unselected mark to the reference data, and it is allowed to add a mark to be confirmed to the reference data, as shown in fig. 1b, so that the document clerk checks for errors.

In fig. 1b, the data below the three columns primary SPEC, secondary SPEC and tertiary SPEC belong to SPEC-type reference data; the data below this column of support cases belongs to the added tagged result.

In the above-described embodiment or the following embodiments, it is necessary to generate a document necessary for a target product from reference data matching a configuration macro included in the target product. In an optional embodiment, in order to improve the document generation efficiency, document templates corresponding to document types may be preset. Based on the method, the document template corresponding to the target document type can be obtained, and the reference data matched with the configuration macro contained in the target product is added to the obtained document template, so that the document required by the target product can be obtained.

In the above embodiment or the following embodiments, in the process of generating a document required by a target product, a configuration macro set and a reference data set corresponding to a target document type need to be used. The macro set and the reference data set corresponding to each document type can be collected in advance.

Configuration macro set collection procedure:

in an initial phase, existing products and configuration macros contained by existing products may be determined. In the case that it is determined that the configuration macro included in the existing product is correct, the configuration macro included in the existing product may be de-duplicated and then imported into the configuration macro set. Or, the configuration macro of the existing product may be imported into the configuration macro set, and then the deduplication processing may be performed.

At a subsequent stage, the set of configuration macros may be incrementally updated each time a new product appears, based on the configuration macros that the new product contains. That is, comparing the configuration macro contained in the new product with the existing configuration macros in the configuration macro set to determine whether all the configuration macros contained in the new product exist in the configuration macro set; and if the judgment result is negative, adding the configuration macro which is not in the configuration macro set in the configuration macros contained in the new product into the configuration macro set.

In addition, there are special cases where the configuration macro is missing, but the required documentation needs to be generated for the product. For example, there is no configuration macro for the earlier version, and in order to be compatible with the historical version, it is required to be able to generate the required documentation for the earlier version of the product. For another example, some evaluation indexes need not be issued to the product user, there may not be a corresponding configuration macro, but the product is verified, so a document including these evaluation indexes needs to be generated for verifying the product. To address the document generation needs in these special cases, users are allowed to customize the configuration macros. Based on this, each time the user customizes the configuration macro, the configuration macro set is updated in an incremental manner according to the user customized configuration macro. Similarly, the configuration macro defined by the user can be compared with the existing configuration macros in the configuration macro set to judge whether all the configuration macros defined by the user exist in the configuration macro set; and if the judgment result is negative, adding the configuration macro which is not in the configuration macro set customized by the user into the configuration macro set.

The configuration macro set can be guaranteed to contain the most complete configuration macros by continuously updating the configuration macro set, and a basis is provided for automatically and accurately generating the document. In addition, the configuration macro set is updated in an incremental mode, so that the updating efficiency is improved, and resources are saved.

Reference data set collection procedure:

in an initial phase, an existing product, a configuration macro contained by the existing product, and benchmark data that matches the configuration macro contained by the existing product may be determined. If the existing reference data is correct, the existing reference data may be de-duplicated and imported into the reference data set. Alternatively, the existing reference data may be imported into the reference data set and then subjected to deduplication processing.

At a subsequent stage, the set of reference data may be incrementally updated based on reference data referenced by the new product whenever a new product appears. That is, the reference data related to the new product is compared with the existing reference data in the reference data set to determine whether all the reference data related to the new product is included in the reference data set; and if the judgment result is negative, adding the reference data which is not in the reference data set and related to the new product into the reference data set.

In addition, there are special cases where reference data corresponding to the configuration macro is absent. For example, the configuration macro does not exist in the early version, and the user customizes the configuration macro for the product of the early version in order to be compatible with the historical version, and corresponding benchmark data is lacked. For another example, for some reference data, the configuration macro of different products is different according to different display requirements of different products. Thus, the user is allowed to customize the reference data so that the reference data corresponds to the configuration macro. Based on this, whenever the user customizes the benchmark data, the benchmark data set can be updated in an incremental manner according to the user customized benchmark data. Comparing the user-defined reference data with the existing reference data in the reference data set to judge whether the user-defined reference data all exist in the reference data set; and if the judgment result is negative, adding the reference data which is not in the reference data set and is defined by the user into the reference data set.

The reference data set can be ensured to contain the most complete reference data by continuously updating the reference data set, and a basis is provided for automatically and accurately generating the document. In addition, the reference data set is updated in an incremental mode, so that the updating efficiency is improved, and resources are saved.

In an application scenario, the target product is assumed to be a product in the communication field, such as a switch, a router, etc. At least one of a SPEC document, a CREF document, an SCG document, an MIB document, an SRS document, and a SYSLOG document may be generated for the target product. The documents belong to different document types and the corresponding reference data sets are different. The following is one explanation:

if the target document type is the SPEC type, the benchmark data set comprises product function description data, and the document required by the target product is the SPEC document. Here, the SPEC document mainly indicates functions supported by the target product, or indicates which functions the target product has, and is generally externally presented in the form of an EXCEL document.

And if the document type is the CREF type, the reference data set comprises product configuration command description data, and the document required by the target product is a CREF document. The CREF document mainly provides each command and parameters thereof provided externally in the target product, and is generally presented externally in a WORD document mode.

And if the target document type is the SCG type, the reference data set comprises product network configuration guidance information, and the document required by the target product is the SCG document. The SCG document mainly provides a target product aiming at the actual network requirement of a user, and a series of commands are combined and configured according to the functions provided by the target product, so that the network requirement of the user is realized, and configuration guidance information such as student internet charging authentication, teacher internet free authentication and the like is provided.

And if the target document type is the MIB type, the reference data set comprises product function node description data, and the document required by the target product is the MIB document. The MIB file is one of contents of a TCP/IP network management protocol standard framework, and defines data items that the target product must hold, operations allowed to be performed on each data item, and meanings thereof, i.e., data variables such as control and state information of the target product accessible by the management system, are held in the MIB file.

And if the target document type is the SRS type, the reference data set comprises product requirement description information, and the document required by the target product is the SRS document. The SRS documentation is made in order to allow both users and software developers to have a common understanding of the initial specifications of the target product, making it the basis of the entire development work. SRS documents contain hardware, functionality, performance, input and output, interface requirements, alarm information, security, data and database, documentation and regulatory requirements, etc. associated with the target product.

And if the target document type is the SYSLOG type, the reference data set comprises product system log information, and the document required by the target product is the SYSLOG document. The SYSLOG document is mainly used for recording log records generated in the running process of a target product.

In one embodiment, a SPEC document needs to be generated for a target product. Then, as shown in FIG. 2, the SPEC document generation process includes:

201. product function description data related to a product set to which a target product belongs are obtained in advance to form a SPEC reference data set.

The product set to which the target product belongs may be different according to different application scenarios. For example, assuming that a company generates documents required for products by using the document generation method according to the embodiments of the present application, all products of the company may constitute the product set, or products of the same series as the target product in the company may constitute the product set, or all products of a department to which the target product belongs in the company may constitute the product set, and so on.

The product function description data is data for explaining the product function, and the product function description data required by different products is different, and the specific difference can be determined according to the difference between the product functions. Generally speaking, the larger the difference between the functions of two products, the larger the difference between the product function description data required by the two products.

In connection with fig. 1b, there is illustrated: "supported frame format Ethernet II", "gigabit SFP supports gigabit optical compatibility, tens of thousands", "gigabit SFP + port, support gigabit optical fiber module", "support 40G interface", "support 100G", "optical module information display, fault alarm, diagnostic parameter measurement", "optical module anti-counterfeiting", "flow control", "support forwarding of ultra-long frames", and the like all belong to product function description data, and are the minimum data units constituting the SPEC document. The 'support of 40G interface' means that the target product supports 40G interface, and the 'optical module anti-counterfeiting' means that the target product has the function of providing optical module anti-counterfeiting, and the like.

Alternatively, SPEC documentation for a product may be stored under a specified directory. Initially, the document generating device may read SPEC documents of historical products in the product set to a specified directory, and may subsequently read SPEC documents of newly added products in the product set to the specified directory at regular intervals, each SPEC document including a number of product function description data. Optionally, the document generating device may automatically parse SPEC documents of the historical product and the newly added product, thereby obtaining product function description data and adding the product function description data to the SPEC benchmark data set. Or, optionally, product function description data in SPEC documents of historical products and newly added products may be manually added to the SPEC reference data set, so that the coverage rate of the SPEC reference data set on the product function description data is ensured, and all relevant product function description data are covered as much as possible.

202. And acquiring the most complete configuration macro related to the product set to which the target product belongs in advance to form a configuration macro set.

The document generating device acquires the configuration macros of the historical products and the newly added products in the product set on one hand, and continuously acquires the configuration macros defined by the user on the other hand, so that the coverage rate of the configuration macros set on the configuration macros is ensured, and all related configuration macros are covered as much as possible.

203. In response to a user's access request, a plurality of tab pages are presented to the user, including a SPEC tab page.

Wherein each tab page corresponds to a document type. The SPEC tag page corresponds to a SPEC document type.

204. In response to an operation of the user selecting the SPEC tab page, the SPEC tab page is presented to the user, and the product list is presented on the SPEC tab page.

205. And determining the target product in response to the operation of selecting the target product from the product list by the user.

206. Judging whether the target product is a product to be issued or a product to be tested; if the product is to be released, go to step 207-; if the product is to be verified, go to step 210-212.

207. And selecting the configuration macro contained in the target product from the configuration macro set according to the configuration macro file of the target product.

208. From the SPEC benchmark data set, product functional description data matching configuration macros comprised by the target product is selected.

209. And generating an SPEC document to be issued according to the product function description data matched with the configuration macro contained in the target product, and ending the operation.

210. And selecting the configuration macro required by the verification target product from the configuration macro set according to the configuration macro file used for verification of the local configuration.

211. From the SPEC benchmark data set, product functional description data is selected that matches the configuration macro required to verify the target product.

212. And generating a SPEC document required by verification according to the product function description data matched with the configuration macro required by the verification target product, and finishing the operation.

In the embodiment, the SPEC reference data set and the configuration macro set are collected in advance, when the SPEC document needs to be generated, the configuration macro set and the SPEC reference data set are used as a basis, and the SPEC document can be automatically generated for the product based on the configuration macro file of the target product and the matching relation between the configuration macro and the product function description data, so that the efficiency is high, and the error probability of the document is favorably reduced.

In another embodiment, a CREF document needs to be generated for the target product. Then as shown in fig. 3a, the generating process of the CREF document includes:

301. and acquiring the most complete product configuration command description data related to the product set to which the target product belongs in advance to form a CREF reference data set.

For the description of the product set, reference may be made to step 201, which is not described in detail herein.

The product configuration command description data refers to data explaining a configuration command of a product, and generally includes the product configuration command and corresponding parameters. The product configuration command description data supported by different products may vary, depending on the differences between the functions of the products. Generally speaking, the greater the difference in functions between two products, the greater the difference in product configuration command description data supported by the two products.

Alternatively, the CREF document for a product may be stored under a designated directory. At first, the document generating device can read CREF documents of historical products in the product set under a specified directory, and then periodically read CREF documents of newly added products in the product set under the specified directory, wherein each CREF document comprises a plurality of product configuration description data. Optionally, the document generating device may automatically parse CREF documents of the historical product and the new product, so as to obtain product configuration command description data and add the product configuration command description data to the CREF reference data set. Or optionally, product configuration command description data in CREF documents of historical products and newly added products can be manually added to the CREF reference data set, so that the coverage rate of the CREF reference data set on the product configuration command description data is ensured, and all relevant product configuration command description data are covered as much as possible.

302. And acquiring the most complete configuration macro related to the product set to which the target product belongs in advance to form a configuration macro set.

303. And in response to the access request of the user, showing a plurality of tab pages to the user, wherein the plurality of tab pages comprise CREF tab pages.

Wherein each tab page corresponds to a document type. The CREF tag page corresponds to the CREF document type.

304. In response to the user's selection of the CREF tab page, the CREF tab page is presented to the user, and the product list is presented on the CREF tab page.

305. And determining the target product in response to the operation of selecting the target product from the product list by the user.

306. Judging whether the target product is a product to be issued or a product to be tested; if the product is to be released, go to step 307 and 309; if the product is to be verified, go to step 310-312.

307. And selecting the configuration macro contained in the target product from the configuration macro set according to the configuration macro file of the target product.

308. From the CREF reference data set, product configuration command description data matching the configuration macro contained in the target product is selected.

309. And generating a CREF document to be issued according to the product configuration command description data matched with the configuration macro contained in the target product, and finishing the operation.

310. And selecting the configuration macro required by the verification target product from the configuration macro set according to the configuration macro file used for verification of the local configuration.

311. From the CREF reference data set, product configuration command description data matching the configuration macro required to verify the target product is selected.

312. And generating a CREF document required by verification according to the product configuration command description data matched with the configuration macro required by the verification of the target product, and finishing the operation.

Wherein, a part of the generated CREF document is schematically shown in FIG. 3 b. In fig. 3b is shown the qos ECN commands supported by the target product, which may turn on or off the global ECN function, belonging to a specific command configuration among the commands supported by the target product, see fig. 3b for details.

In this embodiment, the CREF reference data set and the configuration macro set are collected in advance, and when a CREF document needs to be generated, based on the configuration macro set and the CREF reference data set, the CREF document can be automatically generated for a product based on the configuration macro file of a target product and the matching relationship between the configuration macro and the product configuration command description data, which is not only high in efficiency, but also beneficial to reducing the error probability of the document.

In yet another embodiment, an SCG document needs to be generated for the target product. Then, as shown in fig. 4a, the generation process of the SCG document includes:

401. and acquiring the most complete product network configuration guidance information related to the product set to which the target product belongs in advance to form an SCG reference data set.

The product network configuration guidance information refers to information for guiding a user to perform network configuration on a product, for example, guiding the user how to configure a gateway, guiding the user how to dial up to access the internet, and the like. The product network configuration guidance information supported by different products may vary, and the specific differences may depend on the differences between the functions of the products. Generally speaking, the greater the difference between the functions of two products, the greater the difference between the network configuration guidance information of the products supported by the two products.

Alternatively, the SCG document of the product may be written in a uniform format and stored under a specified directory. At first, the document generating device can read the SCG document of the historical product in the product set under the appointed directory, and then periodically read the SCG document of the newly added product in the product set under the appointed directory, wherein each SCG document comprises a plurality of product network configuration guidance information. Optionally, the document generating device may automatically parse the SCG documents of the historical products and the newly added products, so as to obtain the product network configuration guidance information and add the information to the SCG reference data set. Or, optionally, the product network configuration guidance information in the SCG documents of the historical products and the newly added products may be manually added to the SCG reference data set, so as to ensure the coverage rate of the SCG reference data set on the product network configuration guidance information, and cover all relevant product network configuration guidance information as much as possible.

402. And acquiring a configuration macro related to a product set to which the target product belongs in advance to form a configuration macro set.

403. In response to a user's access request, a plurality of tab pages are presented to the user, the plurality of tab pages including an SCG tab page.

Wherein each tab page corresponds to a document type. The SCG tab page corresponds to the SCG document type.

404. And in response to the operation that the user selects the SCG tab page, the SCG tab page is displayed to the user, and the product list is displayed on the SCG tab page.

405. And determining the target product in response to the operation of selecting the target product from the product list by the user.

406. Judging whether the target product is a product to be issued or a product to be tested; if the product is to be released, go to step 407 and 409; if the product is to be verified, go to step 410-412.

407. And selecting the configuration macro contained in the target product from the configuration macro set according to the configuration macro file of the target product.

408. And selecting product network configuration guidance information matched with the configuration macro contained in the target product from the SCG reference data set.

409. And generating an SCG document to be issued according to the product network configuration guidance information matched with the configuration macro contained in the target product, and finishing the operation.

410. And selecting the configuration macro required by the verification target product from the configuration macro set according to the configuration macro file used for verification of the local configuration.

411. From the SCG reference data set, product network configuration guidance information is selected that matches the configuration macro required to verify the target product.

412. And generating an SCG document required by verification according to the product network configuration guidance information matched with the configuration macro required by the verification target product, and finishing the operation.

Fig. 4b shows a schematic diagram of a part of an SCG document generated according to a set SCG document template. In fig. 4b, 802.1x is the module name, and aaa authorization is one of many commands provided externally by the target product. When the command is tapped, the function provided by the command is to be validated per the user's configuration. For example, if the user configures an IP address binding function, the binding function will be effective when the command is knocked down, so that the user can directly surf the internet without logging in any corner of the whole city after surfing the internet and binding the IP address through a mobile phone.

In the embodiment, the SCG reference data set and the configuration macro set are collected in advance, and when the SCG document needs to be generated, based on the configuration macro set and the SCG reference data set, the SCG document can be automatically generated for the product based on the configuration macro file of the target product and the matching relationship between the configuration macro and the product network configuration guidance information, so that not only is the efficiency high, but also the error probability of the document is favorably reduced.

It should be noted that in the embodiments shown in fig. 2, fig. 3a and fig. 4a, the generation processes of one type of document are respectively given, so that in the data collection stage performed in advance, the reference data set of each document type is collected separately. Of course, if multiple types of documents need to be generated simultaneously, the reference data sets of the document types can be collected together in the data collection stage executed in advance, and since the same product shares one configuration macro combination, only one process of collecting the configuration macro set is needed.

Finally, from the commercial perspective, the method provided by the embodiment of the application is adopted to automatically generate the document required by the product, so that the error probability of the document can be reduced, the complaint of product users can be further reduced, and the image and public praise of companies can be improved. In addition, the larger the company scale is, the more products are, the more product users are, the more documents required by the products are automatically generated by adopting the method provided by the embodiment of the application, the efficiency is higher, the personnel investment of the company in the aspects of document generation and maintenance can be reduced, and the labor cost is saved; moreover, developers, testers, documentation personnel, pre-sales personnel and post-sales personnel of the company can all adopt the method provided by the embodiment of the application to generate the required documents, and the whole operation efficiency of the company is favorably improved.

It should be noted that the execution subjects of the steps of the methods provided in the above embodiments may be the same device, or different devices may be used as the execution subjects of the methods. For example, the execution subjects of steps 101 to 104 may be device a; for another example, the execution subject of steps 101 and 102 may be device a, and the execution subject of steps 103 and 104 may be device B; and so on.

Fig. 5 is a schematic structural diagram of a document generating apparatus according to still another embodiment of the present application. As shown in fig. 5, the document generating apparatus includes: a determination module 51, a first selection module 52, a second selection module 53 and a generation module 54.

And the determining module 51 is used for determining the target product of the document to be generated and the type of the target document to be generated.

The first selecting module 52 is configured to select a configuration macro included in the target product from a configuration macro set according to the configuration macro file of the target product.

And a second selecting module 53, configured to select, from the reference data set corresponding to the target document type, reference data that matches the configuration macro included in the target product.

And the generating module 54 is configured to generate a document required by the target product according to the reference data matched with the configuration macro included in the target product.

In an alternative embodiment, the determining module 51 is specifically configured to:

In an alternative embodiment, the target tab page includes a document export control. When the determining module 51 displays the product list on the target tab page, it is specifically configured to: and responding to the operation of clicking the document export control by the user, and displaying the product list on the target label page.

In an optional embodiment, the second selecting module 53 is specifically configured to:

exporting all the reference data in the reference data set to a list type file;

from the list-type file, reference data with a selected marker is selected.

In an alternative embodiment, the generating module 54 is specifically configured to:

acquiring a document template corresponding to the target document type;

In an optional embodiment, the document generating apparatus further comprises: and updating the module.

An updating module, configured to update the configuration macro set incrementally according to configuration macros included in a new product whenever the new product appears; and/or updating the configuration macro set in an incremental mode according to the user-defined configuration macro every time the user defines the configuration macro.

The update module is further to: updating the reference data set in an incremental manner according to the reference data which is related to the new product and corresponds to the target document type when the new product appears; and/or updating the reference data set in an incremental mode according to the user-defined reference data corresponding to the target document type when the user defines the reference data corresponding to the target document type.

In an optional embodiment, the target document type is a software specification SPEC type, the reference data set includes product function description data, and the document required by the target product is a SPEC document; or

The document type is a command reference CREF type, the benchmark data set comprises product configuration command description data, and the document required by the target product is a CREF document; or

The target document type is a configuration guide (SCG) type, the reference data set comprises product network configuration guidance information, and the document required by the target product is an SCG document; or

The target document type is a Management Information Base (MIB) type, the reference data set comprises product function node description data, and the document required by the target product is an MIB document; or

The target document type is a requirement specification (SRS) type, the reference data set comprises product requirement specification information, and the document required by the target product is an SRS document; or

The target document type is a system log SYSLOG type, the reference data set comprises product system log information, and the document required by the target product is a SYSLOG document.

The document generating apparatus provided in this embodiment may execute the flows of the document generating methods provided in the above method embodiments, and specific working principles thereof are not described again, for details, see the description of the method embodiments.

The document generating device provided by the embodiment can automatically generate the required document for the product based on the configuration macro file of the target product and the matching relationship between the configuration macro and the reference data on the basis of the configuration macro set and the reference data set, so that the efficiency is high, and the error probability of the document is favorably reduced.

Fig. 6 is a schematic structural diagram of an electronic device according to yet another embodiment of the present application. As shown in fig. 6, the electronic device includes a memory 61 and a processor 62.

The memory 61 is mainly used for storing programs, and may be configured to store various other data to support operations on the electronic device. Examples of such data include contact data, phonebook data, messages, pictures, videos, and the like.

The memory 61 may be implemented by any type or combination of volatile or non-volatile memory devices, such as Static Random Access Memory (SRAM), electrically erasable programmable read-only memory (EEPROM), erasable programmable read-only memory (EPROM), programmable read-only memory (PROM), read-only memory (ROM), magnetic memory, flash memory, magnetic or optical disks.

The processor 62 is coupled to the memory 61 for executing programs in the memory 61 for:

In an alternative embodiment, the processor 62, when determining the target product and the target document type, is specifically configured to:

In an alternative embodiment, the target tab page includes a document export control. When the processor 62 displays the product list on the target tab page, it is specifically configured to: and displaying the product list on the target label page in response to the operation of clicking the document export control by the user.

In an alternative embodiment, the processor 62, when selecting the reference data, is specifically configured to:

exporting all the reference data in the reference data set to a list type file;

from the list-type file, reference data with a selected marker is selected.

In an alternative embodiment, the processor 62, when generating the documents required by the target product, is specifically configured to:

acquiring a document template corresponding to the target document type;

In an alternative embodiment, the processor 62 is further configured to: updating the configuration macro set incrementally according to configuration macros included in a new product whenever the new product appears; and/or updating the configuration macro set in an incremental mode according to the user-defined configuration macro every time the user defines the configuration macro.

Further, the processor 62 is also configured to: updating the reference data set in an incremental manner according to the reference data which is related to the new product and corresponds to the target document type when the new product appears; and/or updating the reference data set in an incremental mode according to the user-defined reference data corresponding to the target document type when the user defines the reference data corresponding to the target document type.

In an optional embodiment, the target document type is SPEC type, the reference data set includes product function description data, and the document required by the target product is SPEC document; or

The document type is a CREF type, the reference data set comprises product configuration command description data, and the document required by the target product is a CREF document; or

The target document type is an SCG type, the reference data set comprises product network configuration guidance information, and the document required by the target product is an SCG document; or

The target document type is an MIB type, the reference data set comprises product function node description data, and the document required by the target product is an MIB document; or

The target document type is an SRS type, the reference data set comprises product requirement description information, and the document required by the target product is an SRS document; or

The target document type is SYSLOG type, the reference data set comprises product system log information, and the document required by the target product is SYSLOG document.

Further, as shown in fig. 6, the electronic device further includes: communication components 63, display 64, power components 65, audio components 66, and the like. Only some of the components are schematically shown in fig. 6, and the electronic device is not meant to include only the components shown in fig. 6.

As will be appreciated by one skilled in the art, embodiments of the present invention may be provided as a method, system, or computer program product. Accordingly, the present invention may take the form of an entirely hardware embodiment, an entirely software embodiment or an embodiment combining software and hardware aspects. Furthermore, the present invention may take the form of a computer program product embodied on one or more computer-usable storage media (including, but not limited to, disk storage, CD-ROM, optical storage, and the like) having computer-usable program code embodied therein.

The present invention is described with reference to flowchart illustrations and/or block diagrams of methods, apparatus (systems), and computer program products according to embodiments of the invention. It will be understood that each flow and/or block of the flow diagrams and/or block diagrams, and combinations of flows and/or blocks in the flow diagrams and/or block diagrams, can be implemented by computer program instructions. These computer program instructions may be provided to a processor of a general purpose computer, special purpose computer, embedded processor, or other programmable data processing apparatus to produce a machine, such that the instructions, which execute via the processor of the computer or other programmable data processing apparatus, create means for implementing the functions specified in the flowchart flow or flows and/or block diagram block or blocks.

These computer program instructions may also be stored in a computer-readable memory that can direct a computer or other programmable data processing apparatus to function in a particular manner, such that the instructions stored in the computer-readable memory produce an article of manufacture including instruction means which implement the function specified in the flowchart flow or flows and/or block diagram block or blocks.

These computer program instructions may also be loaded onto a computer or other programmable data processing apparatus to cause a series of operational steps to be performed on the computer or other programmable apparatus to produce a computer implemented process such that the instructions which execute on the computer or other programmable apparatus provide steps for implementing the functions specified in the flowchart flow or flows and/or block diagram block or blocks.

In a typical configuration, a computing device includes one or more processors (CPUs), input/output interfaces, network interfaces, and memory.

The memory may include forms of volatile memory in a computer readable medium, Random Access Memory (RAM) and/or non-volatile memory, such as Read Only Memory (ROM) or flash memory (flash RAM). Memory is an example of a computer-readable medium.

Computer-readable media, including both non-transitory and non-transitory, removable and non-removable media, may implement information storage by any method or technology. The information may be computer readable instructions, data structures, modules of a program, or other data. Examples of computer storage media include, but are not limited to, phase change memory (PRAM), Static Random Access Memory (SRAM), Dynamic Random Access Memory (DRAM), other types of Random Access Memory (RAM), Read Only Memory (ROM), Electrically Erasable Programmable Read Only Memory (EEPROM), flash memory or other memory technology, compact disc read only memory (CD-ROM), Digital Versatile Discs (DVD) or other optical storage, magnetic cassettes, magnetic tape magnetic disk storage or other magnetic storage devices, or any other non-transmission medium that can be used to store information that can be accessed by a computing device. As defined herein, a computer readable medium does not include a transitory computer readable medium such as a modulated data signal and a carrier wave.

It should also be noted that the terms "comprises," "comprising," or any other variation thereof, are intended to cover a non-exclusive inclusion, such that a process, method, article, or apparatus that comprises a list of elements does not include only those elements but may include other elements not expressly listed or inherent to such process, method, article, or apparatus. Without further limitation, an element defined by the phrase "comprising an … …" does not exclude the presence of other like elements in a process, method, article, or apparatus that comprises the element.

As will be appreciated by one skilled in the art, embodiments of the present application may be provided as a method, system, or computer program product. Accordingly, the present application may take the form of an entirely hardware embodiment, an entirely software embodiment or an embodiment combining software and hardware aspects. Furthermore, the present application may take the form of a computer program product embodied on one or more computer-usable storage media (including, but not limited to, disk storage, CD-ROM, optical storage, and the like) having computer-usable program code embodied therein.

The above description is only an example of the present application and is not intended to limit the present application. Various modifications and changes may occur to those skilled in the art. Any modification, equivalent replacement, improvement, etc. made within the spirit and principle of the present application should be included in the scope of the claims of the present application.

Claims

1. A document generation method, comprising:

generating a document required by the target product according to the reference data matched with the configuration macro contained in the target product;

for any document type, the reference data refers to the minimum data unit forming the document of the type.

2. The method of claim 1, wherein determining the target product of the document to be generated and the target document type to be generated comprises:

3. The method of claim 2, wherein the target tab page includes a document export control;

the displaying a product list on the target tab page includes:

4. The method according to claim 1, wherein the selecting, from the reference data set corresponding to the target document type, reference data that matches a configuration macro contained in the target product comprises:

exporting all the reference data in the reference data set to a list type file;

from the list-type file, reference data with a selected marker is selected.

5. The method of claim 1, wherein generating the document required by the target product according to the benchmark data matched with the configuration macro contained in the target product comprises:

acquiring a document template corresponding to the target document type;

6. The method according to any one of claims 1-5, wherein before selecting the configuration macro contained in the target product from the set of configuration macros according to the configuration macro file of the target product, the method further comprises:

7. The method according to any one of claims 1-5, wherein before selecting the benchmark data matching the configuration macro contained in the target product from the benchmark data set corresponding to the target document type, the method further comprises:

8. The method according to any one of claims 1 to 5,

the target document type is a software Specification (SPEC) type, the benchmark data set comprises product function description data, and the document required by the target product is an SPEC document; or

9. A document generation apparatus, comprising:

the generating module is used for generating a document required by the target product according to the reference data matched with the configuration macro contained in the target product;

10. The apparatus of claim 9, further comprising:

11. The apparatus of claim 10, wherein the update module is further configured to:

updating the reference data set in an incremental manner according to the reference data which is related to the new product and corresponds to the target document type when the new product appears; and/or updating the reference data set in an incremental mode according to the user-defined reference data corresponding to the target document type when the user defines the reference data corresponding to the target document type.

12. An electronic device, comprising: a memory and a processor;

the memory is used for storing programs;

the processor to execute the program in the memory to:

13. The electronic device of claim 12, wherein the processor is further configured to:

updating the configuration macro set incrementally according to configuration macros included in a new product whenever the new product appears; and/or updating the configuration macro set in an incremental mode according to the user-defined configuration macro every time the user defines the configuration macro.

14. The electronic device of claim 13, wherein the processor is further configured to: