CN108021353B - 软件产品的说明文档的生成装置、方法、设备及存储介质 - Google Patents

Abstract

本发明实施例提供一种软件产品的说明文档的生成装置、方法、设备及存储介质，该装置包括：自动截图单元，自动获取每个模块的代码进行自动化测试，在测试过程中实时获取测试范围内的页面图像；将当前自动化测试的页面图像与前一次自动化测试的页面图像进行比较；模块文档维护单元在当前自动化测试的页面图像有更新时，根据当前自动化测试的页面图像的更新内容对文字说明进行修改，将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；在当前自动化测试的页面图像未更新时，将文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；产品文档生成单元将各个模块的说明文档整合成模块化软件产品的说明文档。

Description

软件产品的说明文档的生成装置、方法、设备及存储介质

技术领域

本发明涉及软件产品技术领域，特别涉及一种软件产品的说明文档的生成装置、方法、设备及存储介质。

背景技术

软件产品的复杂度随着时间变化增加，而复用程度会随着时间变化降低。模块化被证明是降低软件产品的复杂度和提高可复用度的一种可行方法。模块化后，软件产品可以由多个模块组成，而多个模块经过重新组合后又可以构成新的产品。在模块规模可控的情况下，可以形成丰富的产品线，以应对市场变化而带来的产品变化。但是，软件产品模块化给软件产品的说明文档维护工作带来很大挑战，依靠人工维护工作量大，使得人工维护变的越来越困难。

目前，软件产品的说明文档维护为手工维护，包括的流程为：(1)在软件产品的测试环境运行系统。(2)手工逐个点击软件产品的各个模块的功能并截图。(3)将截图贴入软件产品的说明文档，并加以文字说明。

发明内容

本发明实施例提供了一种模块化软件产品的说明文档的生成装置，以解决现有技术中人工维护软件产品的说明文档时工作量大的技术问题。该装置包括：自动截图单元，用于针对组成模块化软件产品的每个模块，自动获取每个模块的代码进行自动化测试，在测试过程中实时生成测试范围内的页面图像；生成当前自动化测试的页面图像后，获取前一次自动化测试的页面图像，将当前自动化测试的页面图像与前一次自动化测试的页面图像进行比较；模块文档维护单元，用于在比较结果为当前自动化测试的页面图像有更新时，获取与前一次自动化测试的页面图像对应存储的文字说明，根据当前自动化测试的页面图像的更新内容对所述文字说明进行修改，将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；在比较结果为当前自动化测试的页面图像未更新时，将所述文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；产品文档生成单元，用于将组成所述模块化软件产品的各个模块的说明文档整合成所述模块化软件产品的说明文档。

本发明实施例还提供了一种模块化软件产品的说明文档的生成方法，以解决现有技术中人工维护软件产品的说明文档时工作量大的技术问题。该方法包括：针对组成模块化软件产品的每个模块，自动获取每个模块的代码进行自动化测试，在测试过程中实时生成测试范围内的页面图像；针对每个模块，生成当前自动化测试的页面图像后，获取前一次自动化测试的页面图像，将当前自动化测试的页面图像与前一次自动化测试的页面图像进行比较，在比较结果为当前自动化测试的页面图像有更新时，获取与前一次自动化测试的页面图像对应存储的文字说明，根据当前自动化测试的页面图像的更新内容对所述文字说明进行修改，将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；在比较结果为当前自动化测试的页面图像未更新时，将所述文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；将组成所述模块化软件产品的各个模块的说明文档整合成所述模块化软件产品的说明文档。

本发明实施例还提供了一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现上述任一种模块化软件产品的说明文档的生成方法。

本发明实施例还提供了一种计算机可读存储介质，所述计算机可读存储介质存储有执行上述任一种模块化软件产品的说明文档的生成方法的计算机程序。

在本发明实施例中，通过自动截图单元自动获取每个模块的代码进行自动化测试，在测试过程中实时自动生成测试范围内的页面图像，避免人工逐个点击测试软件产品的各个模块的功能并截图而产生的工作量；同时，自动截图单元会将当前自动化测试的页面图像和前一次自动化测试的页面图像进行比较，判断当前自动化测试的页面图像是否有更新，在有更新的情况下，通过模块文档维护单元根据当前自动化测试的页面图像的更新内容对前次测试的文字说明进行修改，并将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；在没有更新的情况下，通过模块文档维护单元将前次测试的文字说明和当前自动化测试的页面图像直接对应存储，形成该模块的说明文档；即在当前自动化测试的页面图像有更新时，才会自动修改文字说明，重新形成该模块的说明文档，在当前自动化测试的页面图像未更新时，无需做任何修改、文字编辑，直接形成该模块的说明文档，与现有技术相比，避免人工对每个模块无论是否有更新均需要重新编辑文字说明形成该模块的说明文档，有利于降低人工的工作量；此外，通过产品文档生成单元自动将组成模块化软件产品的各个模块的说明文档整合成模块化软件产品的说明文档，避免人工生成模块化软件产品的说明文档而产生的工作量。

附图说明

此处所说明的附图用来提供对本发明的进一步理解，构成本申请的一部分，并不构成对本发明的限定。在附图中：

图1是本发明实施例提供的一模块化软件产品的说明文档的生成装置的结构框图；

图2是本发明实施例提供的一种模块化软件产品的说明文档的生成方法的流程图。

具体实施方式

为使本发明的目的、技术方案和优点更加清楚明白，下面结合实施方式和附图，对本发明做进一步详细说明。在此，本发明的示意性实施方式及其说明用于解释本发明，但并不作为对本发明的限定。

在本发明实施例中，提供了一种模块化软件产品的说明文档的生成装置，如图1所示，该装置包括：

自动截图单元101，用于针对组成模块化软件产品的每个模块，自动获取每个模块的代码进行自动化测试，在测试过程中实时生成测试范围内的页面图像；生成当前自动化测试的页面图像后，获取前一次自动化测试的页面图像，将当前自动化测试的页面图像与前一次自动化测试的页面图像进行比较；

模块文档维护单元102，用于在比较结果为当前自动化测试的页面图像有更新时，获取与前一次自动化测试的页面图像对应存储的文字说明，根据当前自动化测试的页面图像的更新内容对所述文字说明进行修改，将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；在比较结果为当前自动化测试的页面图像未更新时，将所述文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；

产品文档生成单元103，用于将组成所述模块化软件产品的各个模块的说明文档整合成所述模块化软件产品的说明文档。

由图1所示可知，在本发明实施例中，通过自动截图单元自动获取每个模块的代码进行自动化测试，在测试过程中实时自动生成测试范围内的页面图像，避免人工逐个点击测试软件产品的各个模块的功能并截图而产生的工作量；同时，自动截图单元会将当前自动化测试的页面图像和前一次自动化测试的页面图像进行比较，判断当前自动化测试的页面图像是否有更新，在有更新的情况下，通过模块文档维护单元根据当前自动化测试的页面图像的更新内容对前次测试的文字说明进行修改，并将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；在没有更新的情况下，通过模块文档维护单元将前次测试的文字说明和当前自动化测试的页面图像直接对应存储，形成该模块的说明文档；即在当前自动化测试的页面图像有更新时，才会自动修改文字说明，重新形成该模块的说明文档，在当前自动化测试的页面图像未更新时，无需做任何修改、文字编辑，直接形成该模块的说明文档，与现有技术相比，避免人工对每个模块无论是否有更新均需要重新编辑文字说明形成该模块的说明文档，有利于降低人工的工作量；此外，通过产品文档生成单元自动将组成模块化软件产品的各个模块的说明文档整合成模块化软件产品的说明文档，避免人工生成模块化软件产品的说明文档而产生的工作量。

具体实施时，为了便于统一维护、统一管控，如图1所示，上述组成模块化软件产品的每个模块的代码可以存储在代码版本控制库中，便于上述自动截图单元101读取，上述模块文档维护单元也可以将模块的说明文档存储在代码版本控制库中。例如，将每次测试的页面图像和文字说明对应存储在代码版本控制库中。上述自动截图单元101还可以将有更新的当前自动化测试的页面图像存储到页面图片库中，以便模块文档维护单元102获取并显示。上述产品文档生成单元103可以将模块化软件产品的说明文档存储在产品文档库中。

具体实施时，在本实施例中，上述自动截图单元101，还用于在测试过程中采用selenium软件(即页面自动化测试工具)实时对测试范围内的页面进行截图来生成页面图像，并为页面图像命名，其中，页面图像的名字中可以包括测试页面路径和测试的序数，该测试的序数可以代表页面图像的版本号，以便自动截图单元101根据版本号在代码版本控制库中获取前次测试的页面图像，版本号命名规则可以为自然数递增，比如1、2、3以此类推。为页面图像命名时名字中测试的序数后边还可以添加后缀。自动化测试脚本中会定义需要截图的页面路径，自动截图单元101执行测试脚本逐个页面路径进行测试并截图。

具体实施时，在本实施例中，上述自动截图单元101，还用于基于计算机视觉库(Open Source Computer Vision Library，OpenCV)对当前自动化测试的页面图像和前一次自动化测试的页面图像进行比较；在判断出当前自动化测试的页面图像有更新时，将当前自动化测试的页面图像存储在页面图片库中；所述模块文档维护单元102，还用于在比较结果为当前自动化测试的页面图像有更新时，从页面图片库中获取并显示当前自动化测试的页面图像，以提示用户判断更新内容是否属于修改文字说明的情况。具体的，属于修改文字说明的情况可以根据实际需要确定，例如，如果截图对应页面的更新较小，不影响产品的使用，则可以确定为不属于修改文字说明的情况；页面图像的更新影响产品的使用时，则可以确定为属于修改文字说明的情况。用户可以通过按钮输入信息的方式指示更新内容是否属于修改文字说明的情况。

具体的，OpenCV是一个跨平台的计算机视觉库，由英特尔公司发起并参与开发，以BSD许可证授权发行，可以在商业和研究领域中免费使用。OpenCV可用于开发实时的图像处理、计算机视觉以及模式识别程序。

具体实施时，为了进一步减少维护说明文档的工作量，且同时确保说明文档的准确性，在本实施例中，所述模块文档维护单元102，还用于在当前自动化测试的页面图像有更新且更新内容属于修改文字说明的情况下，根据当前自动化测试的页面图像的更新内容对所述文字说明进行修改，并将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档。在当前自动化测试的页面图像有更新，但更新内容不属于修改文字说明的情况下，则不对文字说明进行修改，直接将前次测试的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档，不再显示当前自动化测试的页面图像。

具体实施时，为了满足新增模块的维护需求，在本实施例中，所述模块文档维护单元102，还用于针对每个模块，在未获取到前一次自动化测试的页面图像的情况下，判断该模块为新增模块，根据当前自动化测试的页面图像编辑文字说明，并将编辑的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档，并将该模块的说明文档存储在代码版本控制库中，即将编辑的文字说明和当前自动化测试的页面图像对应存储在代码版本控制库中。

具体实施时，为了实现自动生成模块化软件产品的说明文档，并确保模块化软件产品的说明文档的正确性，在本实施例中，产品文档生成单元103，用于获取所述模块化软件产品的产品文档定义文件，根据所述产品文档定义文件中定义的组成所述模块化软件产品的各个模块的组合顺序，将各个模块的说明文档整合成所述模块化软件产品的说明文档。具体的，产品文档定义文件中定义了模块化软件产品由哪些模块组成，以及各个模块之间的组合顺序等信息，产品文档生成单元103获取组成模块化软件产品的各个模块的说明文档，按照各个模块之间的组合顺序将各个模块的说明文档整合成模块化软件产品的说明文档，并将模块化软件产品的说明文档存储在产品文档库中。具体的，产品文档生产单元自动生成的模块化软件产品的说明文档可以为html、pdf、word等格式。

基于同一发明构思，本发明实施例中还提供了一种模块化软件产品的说明文档的生成方法，如下面的实施例所述。由于模块化软件产品的说明文档的生成方法解决问题的原理与模块化软件产品的说明文档的生成装置相似，因此模块化软件产品的说明文档的生成方法的实施可以参见模块化软件产品的说明文档的生成装置的实施，重复之处不再赘述。

图2是本发明实施例的模块化软件产品的说明文档的生成方法的流程图，如图2所示，该方法包括：

步骤201：针对组成模块化软件产品的每个模块，自动获取每个模块的代码进行自动化测试，在测试过程中实时生成测试范围内的页面图像；

步骤202：针对每个模块，生成当前自动化测试的页面图像后，获取前一次自动化测试的页面图像，将当前自动化测试的页面图像与前一次自动化测试的页面图像进行比较，在比较结果为当前自动化测试的页面图像有更新时，获取与前一次自动化测试的页面图像对应存储的文字说明，根据当前自动化测试的页面图像的更新内容对所述文字说明进行修改，将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；在比较结果为当前自动化测试的页面图像未更新时，将所述文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；

步骤203：将组成所述模块化软件产品的各个模块的说明文档整合成所述模块化软件产品的说明文档。

在一个实施例中，在比较结果为当前自动化测试的页面图像有更新时，获取与前一次自动化测试的页面图像对应存储的文字说明，根据当前自动化测试的页面图像的更新内容对文字说明进行修改，包括：在当前自动化测试的页面图像有更新且更新内容属于修改文字说明的情况下，根据当前自动化测试的页面图像的更新内容对所述文字说明进行修改。

在一个实施例中，上述方法还包括：针对每个模块，在未获取到前一次自动化测试的页面图像的情况下，判断该模块为新增模块，根据当前自动化测试的页面图像编辑文字说明，并将编辑的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档。

在一个实施例中，在测试过程中实时生成测试范围内的页面图像，包括：在测试过程中采用selenium软件实时对测试范围内的页面进行截图来生成页面图像，为页面图像命名，其中，页面图像的名字中包括测试页面路径和测试的序数。

在一个实施例中，将当前自动化测试的页面图像与前一次自动化测试的页面图像进行比较，包括：基于计算机视觉库对当前自动化测试的页面图像和前一次自动化测试的页面图像进行比较，在比较结果为当前自动化测试的页面图像有更新时，显示当前自动化测试的页面图像，提示用户判断更新内容是否属于修改文字说明的情况。

在一个实施例中，将组成所述模块化软件产品的各个模块的说明文档整合成所述模块化软件产品的说明文档，包括：获取所述模块化软件产品的产品文档定义文件，根据所述产品文档定义文件中定义的组成所述模块化软件产品的各个模块的组合顺序，将各个模块的说明文档整合成所述模块化软件产品的说明文档。

在本实施例中，还提供了一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现上述任一种模块化软件产品的说明文档的生成方法。

在本实施例中，还提供了一种计算机可读存储介质，所述计算机可读存储介质存储有执行上述任一种模块化软件产品的说明文档的生成方法的计算机程序。该存储介质包括但不限于：光盘、软盘、硬盘、可擦写存储器等。

本发明实施例实现了如下技术效果：通过自动截图单元自动获取每个模块的代码进行自动化测试，在测试过程中实时自动生成测试范围内的页面图像，避免人工逐个点击测试软件产品的各个模块的功能并截图而产生的工作量；同时，自动截图单元会将当前自动化测试的页面图像和前一次自动化测试的页面图像进行比较，判断当前自动化测试的页面图像是否有更新，在有更新的情况下，通过模块文档维护单元根据当前自动化测试的页面图像的更新内容对前次测试的文字说明进行修改，并将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；在没有更新的情况下，通过模块文档维护单元将前次测试的文字说明和当前自动化测试的页面图像直接对应存储，形成该模块的说明文档；即在当前自动化测试的页面图像有更新时，才会自动修改文字说明，重新形成该模块的说明文档，在当前自动化测试的页面图像未更新时，无需做任何修改、文字编辑，直接形成该模块的说明文档，与现有技术相比，避免人工对每个模块无论是否有更新均需要重新编辑文字说明形成该模块的说明文档，有利于降低人工的工作量；此外，通过产品文档生成单元自动根据产品文档定义文件中定义的组成模块化软件产品的各个模块的顺序，将各个模块的说明文档整合成模块化软件产品的说明文档，避免人工生成模块化软件产品的说明文档而产生的工作量。

显然，本领域的技术人员应该明白，上述的本发明实施例的各模块或各步骤可以用通用的计算装置来实现，它们可以集中在单个的计算装置上，或者分布在多个计算装置所组成的网络上，可选地，它们可以用计算装置可执行的程序代码来实现，从而，可以将它们存储在存储装置中由计算装置来执行，并且在某些情况下，可以以不同于此处的顺序执行所示出或描述的步骤，或者将它们分别制作成各个集成电路模块，或者将它们中的多个模块或步骤制作成单个集成电路模块来实现。这样，本发明实施例不限制于任何特定的硬件和软件结合。

以上所述仅为本发明的优选实施例而已，并不用于限制本发明，对于本领域的技术人员来说，本发明实施例可以有各种更改和变化。凡在本发明的精神和原则之内，所作的任何修改、等同替换、改进等，均应包含在本发明的保护范围之内。

Claims (12)

1.一种模块化软件产品的说明文档的生成装置，其特征在于，包括：

自动截图单元，用于针对组成模块化软件产品的每个模块，自动获取每个模块的代码进行自动化测试，在测试过程中实时生成测试范围内的页面图像；生成当前自动化测试的页面图像后，获取前一次自动化测试的页面图像，将当前自动化测试的页面图像与前一次自动化测试的页面图像进行比较；

模块文档维护单元，用于在比较结果为当前自动化测试的页面图像有更新时，获取与前一次自动化测试的页面图像对应存储的文字说明，根据当前自动化测试的页面图像的更新内容对所述文字说明进行修改，将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；在比较结果为当前自动化测试的页面图像未更新时，将所述文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；

产品文档生成单元，用于将组成所述模块化软件产品的各个模块的说明文档整合成所述模块化软件产品的说明文档；

所述自动截图单元，还用于在测试过程中采用页面自动化测试工具实时对测试范围内的页面进行截图来生成页面图像，为页面图像命名，其中，页面图像的名字中包括测试页面路径和测试的序数。

2.如权利要求1所述的模块化软件产品的说明文档的生成装置，其特征在于，所述模块文档维护单元，还用于在当前自动化测试的页面图像有更新且更新内容属于修改文字说明的情况下，根据当前自动化测试的页面图像的更新内容对所述文字说明进行修改。

3.如权利要求1所述的模块化软件产品的说明文档的生成装置，其特征在于，所述模块文档维护单元，还用于针对每个模块，在未获取到前一次自动化测试的页面图像的情况下，判断该模块为新增模块，根据当前自动化测试的页面图像编辑文字说明，并将编辑的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档。

4.如权利要求1至3中任一项所述的模块化软件产品的说明文档的生成装置，其特征在于，

所述自动截图单元，还用于基于计算机视觉库对当前自动化测试的页面图像和前一次自动化测试的页面图像进行比较；

所述模块文档维护单元，还用于在比较结果为当前自动化测试的页面图像有更新时，显示当前自动化测试的页面图像，提示用户判断更新内容是否属于修改文字说明的情况。

5.如权利要求1至3中任一项所述的模块化软件产品的说明文档的生成装置，其特征在于，所述产品文档生成单元，还用于获取所述模块化软件产品的产品文档定义文件，根据所述产品文档定义文件中定义的组成所述模块化软件产品的各个模块的组合顺序，将各个模块的说明文档整合成所述模块化软件产品的说明文档。

6.一种模块化软件产品的说明文档的生成方法，其特征在于，包括：

针对组成模块化软件产品的每个模块，自动获取每个模块的代码进行自动化测试，在测试过程中实时生成测试范围内的页面图像；

针对每个模块，生成当前自动化测试的页面图像后，获取前一次自动化测试的页面图像，将当前自动化测试的页面图像与前一次自动化测试的页面图像进行比较，在比较结果为当前自动化测试的页面图像有更新时，获取与前一次自动化测试的页面图像对应存储的文字说明，根据当前自动化测试的页面图像的更新内容对所述文字说明进行修改，将修改后的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；在比较结果为当前自动化测试的页面图像未更新时，将所述文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档；

将组成所述模块化软件产品的各个模块的说明文档整合成所述模块化软件产品的说明文档；

在测试过程中实时生成测试范围内的页面图像，包括：

在测试过程中采用页面自动化测试工具实时对测试范围内的页面进行截图来生成页面图像，为页面图像命名，其中，页面图像的名字中包括测试页面路径和测试的序数。

7.如权利要求6所述的模块化软件产品的说明文档的生成方法，其特征在于，在比较结果为当前自动化测试的页面图像有更新时，获取与前一次自动化测试的页面图像对应存储的文字说明，根据当前自动化测试的页面图像的更新内容对文字说明进行修改，包括：

在当前自动化测试的页面图像有更新且更新内容属于修改文字说明的情况下，根据当前自动化测试的页面图像的更新内容对所述文字说明进行修改。

8.如权利要求6所述的模块化软件产品的说明文档的生成方法，其特征在于，还包括：

针对每个模块，在未获取到前一次自动化测试的页面图像的情况下，判断该模块为新增模块，根据当前自动化测试的页面图像编辑文字说明，并将编辑的文字说明和当前自动化测试的页面图像对应存储，形成该模块的说明文档。

9.如权利要求6至8中任一项所述的模块化软件产品的说明文档的生成方法，其特征在于，将当前自动化测试的页面图像与前一次自动化测试的页面图像进行比较，包括：

基于计算机视觉库对当前自动化测试的页面图像和前一次自动化测试的页面图像进行比较，在比较结果为当前自动化测试的页面图像有更新时，显示当前自动化测试的页面图像，提示用户判断更新内容是否属于修改文字说明的情况。

10.如权利要求6至8中任一项所述的模块化软件产品的说明文档的生成方法，其特征在于，将组成所述模块化软件产品的各个模块的说明文档整合成所述模块化软件产品的说明文档，包括：

获取所述模块化软件产品的产品文档定义文件，根据所述产品文档定义文件中定义的组成所述模块化软件产品的各个模块的组合顺序，将各个模块的说明文档整合成所述模块化软件产品的说明文档。

11.一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现权利要求6至10中任一项所述的模块化软件产品的说明文档的生成方法。

12.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质存储有执行权利要求6至10中任一项所述的模块化软件产品的说明文档的生成方法的计算机程序。

Images