Help document generation method and device

A technology for helping documents and generating units, which is applied in the direction of program files, software deployment, software maintenance/management, etc. It can solve problems such as complicated steps, long time, and low efficiency, and achieve high accuracy, error-prone, and high efficiency Effect

CN110879721APending Publication Date: 2020-03-13BANK OF CHINA
6 Cites 0 Cited by

Patent Information

Authority / Receiving Office
CN · China
Current Assignee / Owner
Publication Date
2020-03-13

Smart Images

  • Figure 1
    Figure 1
  • Figure 2
    Figure 2
  • Figure 3
    Figure 3
Patent Text Reader

Abstract

The invention discloses a method and a device for generating a help document. The method comprises the following steps: recording an operation command corresponding to each deployment step in a software deployment process; and for each operation command, identifying a timestamp and a deployment result, the timestamp of any one operation command being used for indicating a moment when the softwareexecutes the operation command, and the deployment result of any one operation command being used for indicating a result generated after the software executes the operation command. If the deploymentresult of the operation command indicates that the current deployment step is executed successfully, it is determined that the operation command is a target operation command. And natural language processing is performed on each target operation command in the command sequence to generate a help document, and the command sequence is obtained by sorting each target operation command according to atimestamp. Compared with manual writing, the efficiency is high, errors are not prone to occurring, and the accuracy is high. Since the help document is obtained through conversion based on the operation command, when software deployment is carried out, the help document can be utilized to convert the corresponding operation command, and automatic deployment of the software is realized.
Need to check novelty before this filing date? Find Prior Art

Description

technical field

[0001] The present application relates to the technical field of software development, in particular to a method and device for generating help documents. Background technique

[0002] In the process of software deployment, due to the different attributes of the system environment, the steps and methods of deployment on different system environments are also different. Therefore, in the process of software development, developers are required to write help documents for operation and maintenance personnel based on their development experience and understanding of the software.

[0003] At present, the help documentation is written manually. Due to the complicated steps in the software deployment process, the documentation writing work is very huge. Obviously, manual writing of help documents takes a long time and is inefficient. In addition, in the process of manually writing help documents, it is extremely easy to make mistakes in manually writing help doc...

Examples

Embodiment Construction

[0046] The technical solutions in the embodiments of the present application will be clearly and completely described below in conjunction with the accompanying drawings in the embodiments of the present application. Obviously, the described embodiments are only some of the embodiments of the present application, not all of them. Based on the embodiments in this application, all other embodiments obtained by persons of ordinary skill in the art without making creative efforts belong to the scope of protection of this application.

[0047] It can be seen from the background art that in the process of writing the software help document, due to the complicated steps of the software deployment process, manual writing of the help document takes a long time and is inefficient. In addition, in the process of manually writing help documents, it is extremely easy to make mistakes in manually writing help documents. Therefore, the embodiment of the present application provides a method ...