CN118070742B - 文档生成方法、装置、设备、存储介质及产品 - Google Patents

Abstract

本申请公开了一种文档生成方法、装置、设备、存储介质及产品，方法包括：基于第一文档中所包含的多个描述章节，确定目标内容；目标内容包括同一系列中至少一个其他产品的文档所包含的部分描述章节；根据目标内容生成公共复用文件，并基于公共复用文件生成同一系列中各个产品分别对应的专属文件；在公共复用文件发生内容变动的情况下，对公共复用文件进行检查评审；基于通过检查评审的公共复用文件以及同一系列中各个产品分别对应的专属文件，分别生成各个产品对应的文档。本申请能够通过公共复用文件实现多个产品的文档编写，提高了文档开发的准确性、可靠性和效率，降低了错误风险，还能通过复用公共复用文件提高文件重用率，降低存储资源占用。

Description

文档生成方法、装置、设备、存储介质及产品

技术领域

本申请属于文档开发技术领域，尤其涉及一种文档生成方法、装置、设备、存储介质及产品。

背景技术

电子设计自动化（Electronic design automation，简称EDA）是指利用计算机辅助设计软件，来完成超大规模集成电路（VLSI）芯片的功能设计、综合、验证、物理设计（包括布局、布线、版图、设计规则检查等）等流程的设计方式。

在对同一系列的多款软件产品进行技术开发时，需要对该系统的各个产品进行相应的文档开发。文档工程师们在编写相同或较为相似的文档内容时，通常会采用拷贝复制的方式对已有的文档内容进行复用，从而减少文档开发时间。

然而，在同一系列的软件产品数量较多或者软件产品的迭代更新周期较快时，对每个产品的文档内容进行修改和检查评审的过程十分繁重和低效，将会消耗大量时间资源和人员资源，进而导致开发效率降低，对软件产品的更新和发布产生较大影响。并且，在对不同文档的重复修改和检查的过程中，还可能产生遗漏或偏差风险。

发明内容

本申请实施例提供一种文档生成方法、装置、设备、存储介质及产品，能够改善现有的文档开发过程存在一定缺陷的技术问题。

第一方面，本申请实施例提供一种文档生成方法，方法可以包括：

基于第一文档中所包含的多个描述章节，确定目标内容；目标内容包括同一系列中至少一个其他产品的文档所包含的部分描述章节；

根据目标内容生成公共复用文件，并基于公共复用文件生成同一系列中各个产品分别对应的专属文件；

在公共复用文件发生内容变动的情况下，对公共复用文件进行检查评审；

基于通过检查评审的公共复用文件以及同一系列中各个产品分别对应的专属文件，分别生成各个产品对应的文档。

在一些实施例中，基于第一文档中所包含的多个描述章节，确定目标内容，包括：

基于第一文档中所包含的多个描述章节，根据预设目标筛选规则筛选得到部分描述章节；

根据筛选出的部分描述章节生成目标内容。

在一些实施例中，基于第一文档中所包含的多个描述章节，确定目标内容，还包括：

基于第一文档中所包含的多个描述章节以及同一系列中至少一个其他产品的文档所包含的多个描述章节，确定重复存在的部分描述章节；

基于重复存在的部分描述章节生成目标内容。

在一些实施例中，根据目标内容生成公共复用文件，并基于公共复用文件生成同一系列中各个产品分别对应的专属文件之后，还包括：

在同一系列中的产品数量增加的情况下，将公共复用文件中的各个描述章节与新增的产品进行匹配；

在公共复用文件中所包含的至少一个描述章节的部分功能或特性与新增的产品不匹配的情况下，将不匹配的描述章节进行拆分，得到多个碎片化文件；

基于与新增的产品匹配的一部分碎片化文件更新公共复用文件。

在一些实施例中，将不匹配的描述章节进行拆分，得到多个碎片化文件之后，还包括：

基于与新增的产品不匹配的另一部分碎片化文件，更新原有的各个产品分别对应的专属文件。

在一些实施例中，将不匹配的描述章节进行拆分，得到多个碎片化文件之后，还包括：

基于与新增的产品不匹配的另一部分碎片化文件，生成或更新部分复用文件；部分复用文件包含至少一个特定描述章节，特定描述章节为同一系列中至少两个产品的文档所包含的描述章节。

在一些实施例中，公共复用文件与部分复用文件存储于公共文件数据库。

在一些实施例中，目标内容所包含的每个描述章节为同一系列中的每个产品的文档均包含的描述章节。

第二方面，本申请实施例提供了一种文档生成装置，包括：

确定模块，用于基于第一文档中所包含的多个描述章节，确定目标内容；目标内容包括同一系列中至少一个其他产品的文档所包含的部分描述章节；

公共模块，用于根据目标内容生成公共复用文件，并基于公共复用文件生成同一系列中各个产品分别对应的专属文件；

检评模块，用于在公共复用文件发生内容变动的情况下，对公共复用文件进行检查评审；

生成模块，用于基于通过检查评审的公共复用文件以及同一系列中各个产品分别对应的专属文件，分别生成各个产品对应的文档。

第三方面，本申请实施例提供了一种文档生成设备，处理器以及存储有计算机程序指令的存储器；

处理器执行计算机程序指令时实现第一方面的文档生成方法的步骤。

第四方面，本申请实施例提供了一种计算机可读存储介质，计算机可读存储介质上存储有计算机程序指令，计算机程序指令被处理器执行时实现第一方面的文档生成方法的步骤。

第五方面，本申请实施例提供了一种计算机程序产品，计算机程序产品中的指令被处理器执行时实现第一方面的文档生成方法的步骤。

本申请实施例的文档生成方法、装置、设备、存储介质及产品，基于第一文档中所包含的多个描述章节，可以确定同一系列中的其他产品的文档中与第一文档一致的部分描述章节并作为目标内容。基于该目标内容可以生成公共复用文件，基于公共复用文件所包含的描述章节，每个产品可以将其独有的描述章节生成对应的专属文件。在开发人员对公共复用文件进行内容改动时，可以对改动后的公共复用文件进行检查评审，并将通过检查评审的公共复用文件分别结合每个产品的专属文件，组成每个产品对应的文档。由于所有产品共同包含的功能或特性对应的描述章节存储在公共复用文件中，开发人员通过对公共复用文件进行修改，即可实现全部产品的文档编写，提升了文档开发效率，提高了文档修改的准确性和可靠性，降低了重复修改过程中的低级错误风险。并且，多个产品共同具有的文档内容可以通过公共复用文件进行复用，提高了文件重用率，降低了存储资源的占用率。

附图说明

为了更清楚地说明本申请实施例的技术方案，下面将对本申请实施例中所需要使用的附图作简单的介绍，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1是本申请一实施例提供的文档生成方法的流程示意图；

图2是本申请另一实施例提供的文档生成方法的流程示意图；

图3是本申请又一实施例提供的文档生成方法的流程示意图；

图4是本申请再一实施例提供的文档生成方法的流程示意图；

图5是本申请一实施例提供的产品文档系统架构示意图；

图6是图5中公共文件数据库的公共复用文件的示意图；

图7是图5中专属文件数据库的专属文件的示意图；

图8是本申请一实施例提供的产品A文档的部分内容示意图；

图9是公共文件数据库中create_object的碎片化文件的示意图；

图10是专属文件数据库包含create_object的示意图；

图11是图10中create_object的碎片化文件的示意图；

图12是本申请另一实施例提供的产品A文档的部分内容示意图；

图13是本申请另一个实施例提供的文档生成装置的结构示意图；

图14是本申请又一个实施例提供的文档生成设备的结构示意图。

具体实施方式

下面将详细描述本申请的各个方面的特征和示例性实施例，为了使本申请的目的、技术方案及优点更加清楚明白，以下结合附图及具体实施例，对本申请进行进一步详细描述。应理解，此处所描述的具体实施例仅意在解释本申请，而不是限定本申请。对于本领域技术人员来说，本申请可以在不需要这些具体细节中的一些细节的情况下实施。下面对实施例的描述仅仅是为了通过示出本申请的示例来提供对本申请更好的理解。

需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括……”限定的要素，并不排除在包括要素的过程、方法、物品或者设备中还存在另外的相同要素。

电子设计自动化（Electronic design automation，简称EDA）是指利用计算机辅助设计软件，来完成超大规模集成电路（VLSI）芯片的功能设计、综合、验证、物理设计（包括布局、布线、版图、设计规则检查等）等流程的设计方式。

在对同一系列的多款软件产品进行技术开发时，需要对该系统的各个产品进行相应的文档开发。文档工程师们在编写相同或较为相似的文档内容时，通常会采用拷贝复制的方式对已有的文档内容进行复用，从而减少文档开发时间。

然而，在同一系列的软件产品数量较多或者软件产品的迭代更新周期较快时，对每个产品的文档内容进行修改和检查评审的过程十分繁重和低效，将会消耗大量时间资源和人员资源，进而导致开发效率降低，对软件产品的更新和发布产生较大影响。并且，在对不同文档的重复修改和检查的过程中，还可能产生遗漏或偏差风险。

为了解决上述至少一个技术问题，本申请实施例提供了一种文档生成方法、装置、设备、存储介质及产品。下面首先对本申请实施例所提供的文档生成方法进行介绍。

图1示出了本申请一个实施例提供的文档生成方法的流程示意图。该方法可以包括以下步骤：

S110，基于第一文档中所包含的多个描述章节，确定目标内容；目标内容包括同一系列中至少一个其他产品的文档所包含的部分描述章节；

S120，根据目标内容生成公共复用文件，并基于公共复用文件生成同一系列中各个产品分别对应的专属文件；

S130，在公共复用文件发生内容变动的情况下，对公共复用文件进行检查评审；

S140，基于通过检查评审的公共复用文件以及同一系列中各个产品分别对应的专属文件，分别生成各个产品对应的文档。

在本实施例中，基于第一文档中所包含的多个描述章节，可以确定同一系列中的其他产品的文档中与第一文档一致的部分描述章节并作为目标内容。基于该目标内容可以生成公共复用文件，基于公共复用文件所包含的描述章节，每个产品可以将其独有的描述章节生成对应的专属文件。在开发人员对公共复用文件进行内容改动时，可以对改动后的公共复用文件进行检查评审，并将通过检查评审的公共复用文件分别结合每个产品的专属文件，组成每个产品对应的文档。由于所有产品共同包含的功能或特性对应的描述章节存储在公共复用文件中，开发人员通过对公共复用文件进行修改，即可实现全部产品的文档编写，提升了文档开发效率，提高了文档修改的准确性和可靠性，降低了重复修改过程中的低级错误风险。并且，多个产品共同具有的文档内容可以通过公共复用文件进行复用，提高了文件重用率，降低了存储资源的占用率。

相关技术中，基于现有的文档开发架构，相关人员对于相似或者完全相同的功能和特性，需要编写相似或相同的文档内容。此时为了提高效率，通常采用拷贝和复制等方式，实现文档内容的复用。然而，在面对系列产品的迭代和更新时，需要对所有复制相同内容的文档进行依次修改，此时将会消耗大量文档开发时间，严重影响产品的迭代更新周期。在对相同内容逐一进行复制修改的过程中，还容易产生错漏等问题。并且，针对不同产品的文档，在进行文档内容的修改后，需要分别对每个修改后的文档逐一进行自检、交叉检视和评审，这同样也会消耗大量人力资源和时间成本。而本实施例中对于公共复用文件，在修改后进行一次自检、交叉检视和评审即可实现多个产品的文档编写，能够大大降低检评次数，减少人力资源和时间成本。

下面介绍上述各个步骤的具体实现方式。

在S110中，在对同一系列中的至少两个产品进行文档开发的过程中，可以先对其中一个产品进行文档开发，得到对应的第一文档。可以理解的是，该第一文档中包含有该产品所对应的全部描述章节。

作为一种可选的实施方式，上述产品文档可以包括但不限于软件的用户手册、命令参考手册、版本说明书、规范性文档（spec）等，产品文档的格式可以是PDF（PortableDocument Format，可携带文件格式），也可以是其他文件格式，在此不做限制。产品文档中所包含的描述章节可以包括但不限于通用命令、版权声明、前言、缩略语、参数汇总、报错汇总、术语、参数备注、参数描述、参数示例、返回值和类型、使用说明、使用示例等。

基于第一文档中所包含的多个描述章节，可以从多个描述章节中确定目标内容。该目标内容可以包括同一系列的至少一个其他产品的文档中同样需要包含的部分描述章节。即，从第一文档中的多个描述章节中可以筛选出一部分描述章节作为目标内容，在同一系列中的至少两个产品的文档中均包含有该目标内容。

在一些实施例中，上述S110，可以包括：

S210，基于第一文档中所包含的多个描述章节，根据预设目标筛选规则筛选得到部分描述章节；

S220，根据筛选出的部分描述章节生成目标内容。

在本实施例中，在多个产品中仅开发得到某个产品的文档时，可以将其作为第一文档，根据预设目标筛选规则从第一文档中包含的多个描述章节中筛选出部分描述章节，该部分描述章节即可作为目标内容。

在同一系列的产品的文档开发过程中，若仅对其中一个产品的文档进行开发，并且仅得到对应的第一文档的情况下，可以采用根据目标筛选规则进行筛选的方式，从第一文档所包含的多个描述章节中筛选得到部分描述章节并生成相应的目标内容。

在S210中，在对同一系列的多个产品中的某个产品进行相应的文档开发并得到第一文档后，可以基于第一文档中所包含的多个描述章节，采用预先设置的目标筛选规则进行筛选，以得到其中一部分描述章节。

在一种可选的实施方式中，目标筛选规则可以由文档开发人员进行预先编辑。例如，文档开发人员可以预先设置相应的关键词，基于第一文档中的多个描述章节，可以筛选出包含相应关键词的描述章节。除此之外，目标筛选规则还可以是屏蔽词，该屏蔽词可以是文档开发人员基于同一系列的各个产品之间的差异部分进行设置，在对第一文档中的多个描述章节通过屏蔽词进行筛选后，可以筛选出不包含屏蔽词的部分描述章节。

在利用目标筛选规则对第一文档中的多个描述章节进行筛选后，可以将筛选出的部分描述章节显示给文档开发人员，并基于文档开发人员的控制指令对描述章节进行进一步的增删操作。

在S220中，在筛选得到部分描述章节后，可以根据筛选出的该部分描述章节生成目标内容。

在一些实施例中，上述S110，还可以包括：

S310，基于第一文档中所包含的多个描述章节以及同一系列中至少一个其他产品的文档所包含的多个描述章节，确定重复存在的部分描述章节；

S320，基于重复存在的部分描述章节生成目标内容。

在本实施例中，在已经开发得到多个产品的文档时，可以将其中一个文档作为第一文档，将第一文档与其他文档所包含的描述章节进行匹配，得到多个文档中均重复存在的部分描述章节作为目标内容。

在同一系列的产品的文档开发过程中，若已经对至少两个产品的文档进行开发，得到了第一文档以及同一系列中至少一个其他产品的文档，则可以采用将第一文档与其他的文档进行匹配比较的方式，确定各个文档中均包含的重复的描述章节并生成相应的目标内容。

在S310中，在对同一系列中的至少两个产品进行文档开发后，可以得到其中一个产品对应的第一文档以及至少一个其他产品对应的文档。第一文档以及其他产品的文档中均包含有多个描述章节。

基于第一文档中所包含的多个描述章节，可以与其他产品的文档所包含的多个描述章节进行匹配，以得到在多个文档中重复存在的部分描述章节。

在对包含第一文档在内的两个文档进行描述章节的匹配后，得到的重复存在的部分描述章节即为两个文档中均存在的描述章节。在对包含第一文档在内的三个及以上的文档进行描述章节的匹配后，得到的重复存在的部分描述章节即为第一文档和其他所有文档中均存在的描述章节。

在S320中，在筛选得到部分描述章节后，可以根据筛选出的该部分描述章节生成目标内容。

在S120中，基于目标内容可以生成公共复用文件，上述目标内容是指能够作为多个文档的公共部分的数据内容，而公共复用文件则是能够存储于数据库中的数据文件。作为一种示例，公共复用文件可以为XML文件或者markdown文件。

在生成公共复用文件后，可以根据同一系列中各个产品所对应的文档具体所包含的描述章节，确定每个产品所对应的文档中除公共复用文件中所包含的描述章节以外的剩余描述章节。

基于每个产品所对应的剩余描述章节，可以生成该产品对应的专属文件。在将每个产品所对应的剩余描述章节生成为每个产品对应的专属文件后，即可得到同一系列中各个产品分别对应的专属文件。

在一种实施方式中，同一系列中可以包括产品A、产品B以及产品C。基于产品A进行文档开发可以得到第一文档，通过上述实施方式生成公共复用文件后，基于产品A所包含的全部描述章节，确定公共复用文件中未包含的描述章节，并将公共复用文件中未包含的描述章节进行组合以生成产品A对应的专属文件。同样地，基于公共复用文件中未包含的产品B的描述章节可以组建生成产品B对应的专属文件，基于公共复用文件中未包含的产品C的描述章节可以组建生成产品C对应的专属文件。

上述公共复用文件可以存储于公共文件数据库，各个产品分别对应的专属文件则可以存储于专属文件数据库。

请参照图2，在一些实施例中，上述S120之后，还可以包括：

S410，在同一系列中的产品数量增加的情况下，将公共复用文件中的各个描述章节与新增的产品进行匹配；

S420，在公共复用文件中所包含的至少一个描述章节的部分功能或特性与新增的产品不匹配的情况下，将不匹配的描述章节进行拆分，得到多个碎片化文件；

S430，基于与新增的产品匹配的一部分碎片化文件更新公共复用文件。

在本实施例中，在系列中的产品数量发生变动时，可以将公共复用文件中的各个描述章节与新增的产品进行匹配。在某个描述章节与新增的产品不匹配时，可以将不匹配的描述章节进行拆分，并将拆分后与新增的产品匹配的一部分碎片化文件更新在公共复用文件中，以替换掉原有的不匹配的描述章节。

在S410中，在基于同一系列的多个产品，生成公共复用文件和每个产品分别对应的专属文件后。若同一系列中的产品数量增加，例如为新客户提供相应的定制软件产品时，由于新增的产品与原有的各个产品可能存在差异，此时公共复用文件中所包含的描述章节可能并非全部适配于新增的产品。因此，在同一系列中的产品数量增加时，可以将公共复用文件中的各个描述章节与新增的产品进行匹配。

上述匹配过程可以是文档开发人员根据新增的产品的功能或特性进行判断。即，判断公共复用文件中的各个描述章节是否为新增的产品中所需要包含的描述章节。若为新增的产品中所需要包含的描述章节，则表示该描述章节与新增的产品相匹配，反之则不匹配。

在S420中，在对公共复用文件中的各个描述章节进行匹配判断后，若公共复用文件中所包含的全部描述章节对应的功能或特性均与新增的产品相匹配，则表示该公共复用文件中所包含的全部描述章节均适用于新增的产品的文档中。此时可以继续保留该公共复用文件，并基于公共复用文件中所包含的描述章节和新增的产品所需的全部描述章节，确定新增的产品所独有的描述章节，并生成新增的产品对应的专属文件。

若公共复用文件中所包含的多个描述章节中，至少存在一个描述章节的部分功能或特性与新增的产品不匹配时，可以将该不匹配的描述章节进行拆分，得到多个碎片化文件。

以某个描述章节为例，在将该描述章节的功能或特性与新增的产品匹配时，若该描述章节对应的部分功能或特性并非新增的产品所包含的功能或特性，或者该描述章节对应的部分功能或特性与新增的产品所包含的功能或特性存在矛盾冲突，则表示该描述章节与新增的产品不匹配。

在公共复用文件所包含的多个描述章节中，若存在多个描述章节对应的部分功能或特性均与新增的产品不匹配，则可以分别将每个不匹配的描述章节进行拆分，以得到每个描述章节拆分后对应的多个碎片化文件。

在S430中，以公共复用文件中包含一个与新增的产品不匹配的描述章节为例，在将不匹配的描述章节进行拆分得到多个碎片化文件后，可以对每个碎片化文件是否与新增的产品相匹配进行判断。

在多个碎片化文件中的某个碎片化文件对应的功能或特性为新增的产品中的功能或特性时，可以确定该碎片化文件与新增的产品匹配。从多个碎片化文件中确定出与新增的产品匹配的一部分碎片化文件后，可以基于该部分碎片化文件对公共复用文件进行更新。

上述对公共复用文件进行更新，是指将公共复用文件中与新增的产品不匹配的描述章节替换为与新增的产品匹配的一部分碎片化文件，相当于将原有的不匹配的描述章节中不匹配的部分进行删除，仅保留与新增的产品匹配的部分。由于公共复用文件中原有的描述章节为同一系列的产品中除新增的产品外均包含的描述章节，将该部分描述章节替换为描述章节拆分后的部分碎片化文件后，原有的产品中毫无疑问地包含该部分碎片化文件，此时，该部分碎片化文件为同一系列的原有产品与新增的产品共同包含的内容。

在一种可选的实施方式中，若公共复用文件中包含多个与新增的产品不匹配的描述章节，则可以分别对每个描述章节执行上述实施方式中的步骤，得到每个描述章节中的部分碎片化文件，并基于每个描述章节的部分碎片化文件更新公共复用文件。

请参照图3，在一些实施例中，上述S420之后，还可以包括：

S440，基于与新增的产品不匹配的另一部分碎片化文件，更新原有的各个产品分别对应的专属文件。

在本实施例中，在对公共复用文件进行更新后，由于原有的与新增产品不匹配的描述章节被替换为描述章节拆分后得到的碎片化文件中的一部分，部分内容发生缺失。此时公共复用文件与原有的产品对应的专属文件进行组合后，无法得到原有的产品对应的文档。因此，在将公共复用文件进行更新后，还需要将描述章节拆分后得到的多个碎片化文件中，与新增的产品不匹配的另一部分碎片化文件更新至原有的各个产品分别对应的专属文件中。

在一种实施方式中，同一系列中可以包括产品A、产品B以及产品C。在基于新增的产品D将公共复用文件中的描述章节更新为描述章节所包含的一部分碎片化文件后，为了实现公共复用文件与每个产品的专属文件能够组合生成每个产品对应的文档，需要将描述章节中未保留在公共复用文件中的另一部分碎片化文件分别更新至产品A、产品B以及产品C的专属文件中。

作为一种可选的实施方式，在同一系列的产品数量发生减少时，可以对剩余的各个产品的专属文件进行检视，以将剩余的各个产品均包含的描述章节或碎片化文件更新至公共文件数据库中。

以同一系列中包括产品A、产品B、产品C以及产品D为例，在产品D新增进来时，原有的某个描述章节与新增的产品D不匹配，导致该描述章节仅有部分碎片化文件留在公共文件数据库中，而与产品D不匹配的另一部分碎片化文件则存储在产品A、产品B、产品C的专属文件数据库中。若系列产品将产品D进行排除，则存储在产品A、产品B、产品C的专属文件数据库中的碎片化文件与该系列中所有产品均能够匹配。此时可以将存储在各个产品的专属文件数据库中的碎片化文件重新转移至公共文件数据库中。

可以理解的是，在将碎片化文件转移至公共文件数据库后，还可以与公共文件数据库中原有的碎片化文件进行合并，以得到拆分前的描述章节。

请参照图4，在一些实施例中，上述S420之后，还可以包括：

S450，基于与新增的产品不匹配的另一部分碎片化文件，生成或更新部分复用文件；部分复用文件包含至少一个特定描述章节，特定描述章节为同一系列中至少两个产品的文档所包含的描述章节。

与上述将不匹配的另一部分碎片化文件更新至每个产品的专属文件的实施方式不同的是，在本实施例中，在根据不匹配的描述章节拆分出的一部分碎片化文件更新公共复用文件后，可以基于与新增的产品不匹配的另一部分碎片化文件生成部分复用文件，或者更新部分复用文件。

部分复用文件中包含有至少一个特定描述章节，该特定描述章节为同一系列中至少两个产品的文档所包含的描述章节。

需要说明的是，本实施例仅应用于同一系列中的产品数量达到三个或三个以上的情况。以同一系列中包括产品A、产品B以及产品C为例，在基于新增的产品D将公共复用文件中的描述章节更新为描述章节所包含的一部分碎片化文件后，由于该描述章节中的另一部分碎片化文件毫无疑问地属于原有的产品A、产品B以及产品C共同包含的内容，仅产品D未包含该部分内容。因此，该部分碎片化文件可以作为特定描述章节生成部分复用文件。即，部分复用文件中所包含的特定描述章节，并非同一系列中所有产品的文档均包含有的描述章节，而是同一系列中至少两个产品的文档所包含的描述章节。

在基于描述章节拆分后的部分碎片化文件更新公共复用文件后，利用与新增的产品不匹配的另一部分碎片化文件生成特定描述章节的过程中，若此前未曾生成过部分复用文件，则可以利用该特定描述章节生成部分复用文件。相应地，若此前已生成过部分复用文件，则可以将该特定描述章节添加至部分复用文件中，以实现部分复用文件的更新。例如，在原有的产品A、产品B、产品C的基础上新增产品D。此时，仅与产品A、产品B以及产品C匹配，而不与产品D匹配的另一部分碎片化文件可以生成相应的部分复用文件，该部分复用文件即为产品A、产品B以及产品C所对应的部分复用文件。

在此之后，若再次新增产品E，并从公共复用文件中将不与产品E匹配的描述章节进行拆分后，可以得到与不与产品E匹配的部分碎片化文件，若该部分碎片化文件仅与产品A、产品B以及产品C匹配，则该部分碎片化文件可以更新至原有的产品A、产品B以及产品C所对应的部分复用文件中；若该部分碎片化文件与产品A、产品B、产品C以及产品D匹配，则可以基于该部分碎片化文件生成新的部分复用文件。

作为一种可选的实施方式，在同一系列的产品数量发生减少时，可以对各个部分复用文件进行检视。以同一系列中包括产品A、产品B、产品C以及产品D为例，若系列产品将产品D进行排除，则可以对部分复用文件进行检视，将与产品A、产品B和产品C对应的部分复用文件更新为公共复用文件。

在一些实施例中，公共复用文件与部分复用文件存储于公共文件数据库。由于公共复用文件所包含的描述章节为同一系列中所有产品均包含的内容，公共复用文件可以存储于公共文件数据库，以便于文档开发人员在需要进行文档开发时能够仅对公共复用文件进行修改，以实现全部产品的文档中对共同内容的修改。

同样地，部分复用文件中所包含的特定描述章节为至少两个产品的文档所包含的内容，将部分复用文件存储于公共文件数据库，可以使得文档开发人员在需要对部分产品的文档的共同内容进行修改时，能够通过对部分复用文件进行一次修改，实现该部分产品的文档内容的批量修改。即，能够实现部分产品的文档编写，提高文档开发效率。

在S130中，在生成公共复用文件和每个产品分别对应的专属文件后。若同一系列的产品需要进行迭代或更新时，在对产品进行迭代更新的过程中，还需要相应地修改产品对应的文档内容。此时，文档开发人员可以对公共复用文件中的描述章节进行内容修改。

在检测到公共复用文件中的内容发生变动时，可以对公共复用文件进行检查评审。

检查评审过程中，可以是对公共复用文件中的各个描述章节均进行检查评审，也可以仅对公共复用文件中发生内容变动的部分进行检查评审，在此不做限制。

上述检查评审的步骤可以包括对描述章节的自检、交叉检视以及技术评审。

在S140中，在对公共复用文件进行检查评审后，可以基于通过检查评审的公共复用文件与同一系列中的各个产品分别对应的专属文件进行组合，以得到各个产品分别对应的文档。

作为一种可选的实施方式，产品文档的生成可以是，通过DITA Open Toolkit的DITA映射方法，利用公共复用文件和产品独有的专属文件组装生成产品文档，也可以是在支持DITA的文档生成管理软件里加载相应的插件，通过插件实现XML文件组装生成产品文档。

可以理解的是，通过对每个产品的文档进行解耦，能够将同一系列中所有产品共同包含的文档内容以公共复用文件的方式进行存储。在对各个产品共用对应的内容进行修改时，仅需要对公共复用文件进行维护修改，即可实现所有产品的文档内容更新。相比于单独修改每个产品对应的文档的相关技术，能够避免在不同产品的文档中重复编写相同的内容，大大降低产品文档的维护成本，提高了文档开发效率。同时，通过每个产品对应的专属文件，也能够保留每个产品独特的功能或者特性。并且，由于所有产品在生成相应的文档时，均从同一源头（公共复用文件）获取到内容信息，在对文档内容进行修改时，还能确保多个产品的文档内容的同源性和准确性，降低重复编写过程中产生低级错误的风险。

在一些实施例中，目标内容所包含的每个描述章节为同一系列中的每个产品的文档均包含的描述章节。目标内容包括同一系列中的所有产品的文档中均包含的描述章节，而仅有部分产品的文档中包含的描述章节不属于目标内容所包含的描述章节。即，本实施例中，对于部分产品的文档所包含的描述章节，并不会生成部分复用文件，而是将该部分描述章节分别更新至对应的部分产品的专属文件中。

作为一种可选的实施方式，以同一系列中的产品A、产品B以及产品C所具有的公共特性“create_object”命令为例，对上述实施例进行说明。

请参照图5，图5为同一系列中的产品文档系统架构，其中，File Database为存储公共复用文件的公共文件数据库，Product A Documentation为存储产品A的专属文件的专属文件数据库。相应地，Product B Documentation、Product C Documentation分别为存储产品B、产品C的专属文件的专属文件数据库。

如图6所示，在公共文件数据库File Database中，存储着同一系列的产品A、产品B以及产品C共同具有的公共特性分别对应的多个XML格式的公共复用文件。例如，公共文件数据库中存储的公共复用文件可以包括CH_create_object.xml、CH_get_object.xml、CH_remove_object.xml、CH_set_object.xml以及版权声明.xml等。

作为一种可选的示例，公共文件数据库中还可以存储上述公共复用文件的其他语言版本，例如，版权声明.xml对应的英文版本公共复用文件为copyright.xml。

如图7所示，在产品A的专属文件数据库Product A Documentation中，存储着产品A所单独具有的特性对应的公共复用文件。例如，前言.xml、命令参考.xml、CH_config_clock.xml、CH_read_file、CH_report_data、附录1：工具参数汇总.xml、附录2：工具报错汇总.xml、附录3：术语.xml以及附录4：缩略语等。同样地，专属文件数据库中也可以一并存储上述专属文件的其他语言版本。

在生成公共复用文件和产品A对应的专属文件后，可以将公共文件数据库中的公共复用文件与产品A的专属文件数据库中的专属文件进行组装，以生成产品A对应的文档。图8示出了组装后的产品A文档的部分内容。可以理解的是，该产品A文档中的内容分别来自于公共文件数据库中的公共复用文件以及产品A的专属文件数据库中的专属文件。例如，产品A文档中的create_object来源于公共文件数据库中的公共复用文件CH_create_object.xml。

在另一种可选的实施方式中，以同一系列中的产品A、产品B、产品C以及产品N所具有的公共特性“create_object”命令为例，对上述实施例进行说明。

在本实施例中，产品A的“create_object”命令与其他产品的“create_object”命令稍有差异，并非完全一致。因此，无法将“create_object”命令作为公共复用文件直接存储在公共文件数据库中。

在上述情况下，需要将公共特性“create_object”命令对应的XML文件（CH_create_object.xml）进行碎片化处理。

CH_create_object.xml经过碎片化处理后，可以分离出两个部分，其中一部分碎片化文件为产品A、产品B、产品C以及产品N所共同具有的公共特性，另一部分碎片化文件则仅为产品A单独具有的特性。因此，如图9所示，可以将所有产品所共同具有的特性对应的这部分碎片化文件作为新的公共复用文件存储在公共文件数据库中，并替换掉公共文件数据库中原有的CH_create_object.xml。

CH_create_object.xml经过碎片化处理后得到的另一部分碎片化文件与其他的产品不匹配，属于产品A单独具有的特性，该部分碎片化文件可以添加至产品A的专属文件数据库中。如图10所示，产品A的专属文件数据库中可以新增“create_object”命令的专属文件。

图11示出了产品A的专属文件数据库中新增的作为“create_object”命令的专属文件的碎片化文件，其中可以包括CH_参数4_备注.xml、CH_参数4_描述.xml、CH_参数4_示例.xml、CH_create_object_2命令格式.xml、CH_create_object_3-4命令参数.xml等。

结合图9和图11可知，原有的公共复用文件CH_create_object.xml被拆分为多个碎片化文件，其中一部分，例如与参数1、参数2和参数3相关的备注、描述和示例部分仍继续保留在公共文件数据库中，而与参数4相关的备注、描述和示例部分则存储在产品A的专属文件数据库。除此之外，命令描述、命令格式、返回值和类型、使用说明、使用示例和相关命令等各个产品所共通的内容也仍保留在公共文件数据库中。

在将公共文件数据库中原有的CH_create_object.xml进行拆分，将一部分碎片化文件替换掉公共文件数据库中原有的CH_create_object.xml，将另一部分碎片化文件存储至产品A的专属文件数据库后，可以将公共文件数据库中“create_object”命令的碎片化文件与产品A中“create_object”命令的碎片化文件进行组装，以生成产品A的文档。

图12示出了组装后的产品A文档的部分内容。以该产品A文档中create_object的参数描述部分为例，4个参数的相关内容中，前三个参数的参数名称、参数解释、取值示例以及备注来源于公共文件数据库中的公共复用文件，第四个参数的参数名称、参数解释、取值示例以及备注则来源于产品A的专属文件数据库。

需要说明的是，上述本申请实施例描述的应用场景是为了更加清楚的说明本申请实施例的技术方案，并不构成对于本申请实施例提供的技术方案的限定，本领域普通技术人员可知，随着新应用场景的出现，本申请实施例提供的技术方案对于类似的技术问题，同样适用。

基于相同的发明构思，本申请还提供了一种文档生成装置。具体结合图13进行详细说明。

图13是本申请实施例提供的一种文档生成装置1300的结构示意图。

如图13所示，该文档生成装置1300可以包括：

确定模块1301，用于基于第一文档中所包含的多个描述章节，确定目标内容；目标内容包括同一系列中至少一个其他产品的文档所包含的部分描述章节；

公共模块1302，用于根据目标内容生成公共复用文件，并基于公共复用文件生成同一系列中各个产品分别对应的专属文件；

检评模块1303，用于在公共复用文件发生内容变动的情况下，对公共复用文件进行检查评审；

生成模块1304，用于基于通过检查评审的公共复用文件以及同一系列中各个产品分别对应的专属文件，分别生成各个产品对应的文档。

下面对上述文档生成装置1300进行详细说明，具体如下所示：

在一些实施例中，上述确定模块1301，可以包括：

第一筛选子模块，用于基于第一文档中所包含的多个描述章节，根据预设目标筛选规则筛选得到部分描述章节；

第一生成子模块，用于根据筛选出的部分描述章节生成目标内容。

在一些实施例中，上述确定模块1301，还可以包括：

第二筛选子模块，用于基于第一文档中所包含的多个描述章节以及同一系列中至少一个其他产品的文档所包含的多个描述章节，确定重复存在的部分描述章节；

第二生成子模块，基于重复存在的部分描述章节生成目标内容。

在一些实施例中，上述文档生成装置1300，还可以包括：

匹配模块，用于在同一系列中的产品数量增加的情况下，将公共复用文件中的各个描述章节与新增的产品进行匹配；

碎片化模块，用于在公共复用文件中所包含的至少一个描述章节的部分功能或特性与新增的产品不匹配的情况下，将不匹配的描述章节进行拆分，得到多个碎片化文件；

第一更新模块，用于基于与新增的产品匹配的一部分碎片化文件更新公共复用文件。

在一些实施例中，上述文档生成装置1300，还可以包括：

第二更新模块，用于基于与新增的产品不匹配的另一部分碎片化文件，更新原有的各个产品分别对应的专属文件。

在一些实施例中，上述文档生成装置1300，还可以包括：

第三更新模块，用于基于与新增的产品不匹配的另一部分碎片化文件，生成或更新部分复用文件；部分复用文件包含至少一个特定描述章节，特定描述章节为同一系列中至少两个产品的文档所包含的描述章节。

图14示出了本申请实施例提供的文档生成设备的硬件结构示意图。其中，文档生成设备可以为计算机、服务器和文档生成专用设备中的至少一种。该文档生成设备包括处理器1401以及存储有计算机程序指令的存储器1402。

具体地，上述处理器1401可以包括中央处理器（CPU），或者特定集成电路（Application Specific Integrated Circuit ，ASIC），或者可以被配置成实施本申请实施例的一个或多个集成电路。

存储器1402可以包括用于数据或指令的大容量存储器。举例来说而非限制，存储器1402可包括硬盘驱动器（Hard Disk Drive，HDD）、软盘驱动器、闪存、光盘、磁光盘、磁带或通用串行总线（Universal Serial Bus，USB）驱动器或者两个或更多个以上这些的组合。在合适的情况下，存储器1402可包括可移除或不可移除(或固定)的介质。在合适的情况下，存储器1402可在文档生成设备的内部或外部。在特定实施例中，存储器1402是非易失性固态存储器。

存储器1402可包括只读存储器（ROM），闪存设备，随机存取存储器（RAM），磁盘存储介质设备，光存储介质设备，电气、光学或其他物理/有形的存储器存储设备。因此，通常，存储器1402包括一个或多个软件的有形（非暂态）计算机可读存储介质（例如，存储器设备），该软件可以编码有计算机可执行指令，并且当该软件被执行（例如，由一个或多个处理器）时，其可操作来执行参考根据本公开的上述方面的方法所描述的操作。

处理器1401通过读取并执行存储器1402中存储的计算机程序指令，以实现上述实施例中的任意一种文档生成方法。

在一个示例中，文档生成设备还可包括通信接口1403和总线1410。其中，如图14所示，处理器1401、存储器1402、通信接口1403通过总线1410连接并完成相互间的通信。

通信接口1403，主要用于实现本申请实施例中各模块、装置、单元和/或设备之间的通信。

总线1410包括硬件、软件或两者，将文档生成设备的部件彼此耦接在一起。举例来说而非限制，总线可包括加速图形端口（AGP）或其他图形总线、增强工业标准架构（EISA）总线、前端总线（FSB）、超传输（HT）互连、工业标准架构（ISA）总线、无限带宽互连、低引脚数（LPC）总线、存储器总线、微信道架构（MCA）总线、外围组件互连（PCI）总线、PCI-Express（PCI-X）总线、串行高级技术附件（SATA）总线、视频电子标准协会局部（VLB）总线或其他合适的总线或者两个或更多个以上这些的组合。在合适的情况下，总线1410可包括一个或多个总线。尽管本申请实施例描述和示出了特定的总线，但本申请考虑任何合适的总线或互连。

该文档生成设备可以基于文档生成方法，从而实现结合图1至图4以及图13描述的文档生成方法和装置。

另外，结合上述实施例中的文档生成方法，本申请实施例可提供一种计算机存储介质来实现。该计算机存储介质上存储有计算机程序指令；该计算机程序指令被处理器执行时实现上述实施例中的任意一种文档生成方法。计算机可读存储介质的示例包括非暂态计算机可读存储介质，如便携式盘、硬盘、随机存取存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、便携式紧凑盘只读存储器(CD-ROM)、光存储器件、磁存储器件等。

另外，本申请实施例还提供了一种计算机程序产品，包括计算机程序，计算机程序被处理器执行时可实现前述方法实施例的步骤及相应内容。

需要明确的是，本申请并不局限于上文所描述并在图中示出的特定配置和处理。为了简明起见，这里省略了对已知方法的详细描述。在上述实施例中，描述和示出了若干具体的步骤作为示例。但是，本申请的方法过程并不限于所描述和示出的具体步骤，本领域的技术人员可以在领会本申请的精神后，作出各种改变、修改和添加，或者改变步骤之间的顺序。

以上所述的结构框图中所示的功能块可以实现为硬件、软件、固件或者它们的组合。当以硬件方式实现时，其可以例如是电子电路、专用集成电路（ASIC）、适当的固件、插件、功能卡等等。当以软件方式实现时，本申请的元素是被用于执行所需任务的程序或者代码段。程序或者代码段可以存储在机器可读介质中，或者通过载波中携带的数据信号在传输介质或者通信链路上传送。“机器可读介质”可以包括能够存储或传输信息的任何介质。机器可读介质的例子包括电子电路、半导体存储器设备、ROM、闪存、可擦除ROM（EROM）、软盘、CD-ROM、光盘、硬盘、光纤介质、射频（RF）链路，等等。代码段可以经由诸如因特网、内联网等的计算机网络被下载。

还需要说明的是，本申请中提及的示例性实施例，基于一系列的步骤或者装置描述一些方法或系统。但是，本申请不局限于上述步骤的顺序，也就是说，可以按照实施例中提及的顺序执行步骤，也可以不同于实施例中的顺序，或者若干步骤同时执行。

上面参考根据本申请的实施例的方法、装置（系统）和计算机程序产品的流程图和/或框图描述了本申请的各方面。应当理解，流程图和/或框图中的每个方框以及流程图和/或框图中各方框的组合可以由计算机程序指令实现。这些计算机程序指令可被提供给通用计算机、专用计算机、或其它可编程数据处理装置的处理器，以产生一种机器，使得经由计算机或其它可编程数据处理装置的处理器执行的这些指令使能对流程图和/或框图的一个或多个方框中指定的功能/动作的实现。这种处理器可以是但不限于是通用处理器、专用处理器、特殊应用处理器或者现场可编程逻辑电路。还可理解，框图和/或流程图中的每个方框以及框图和/或流程图中的方框的组合，也可以由执行指定的功能或动作的专用硬件来实现，或可由专用硬件和计算机指令的组合来实现。

以上所述，仅为本申请的具体实施方式，所属领域的技术人员可以清楚地了解到，为了描述的方便和简洁，上述描述的系统、模块和单元的具体工作过程，可以参考前述方法实施例中的对应过程，在此不再赘述。应理解，本申请的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本申请揭露的技术范围内，可轻易想到各种等效的修改或替换，这些修改或替换都应涵盖在本申请的保护范围之内。

Claims (10)

1.一种文档生成方法，其特征在于，包括：

基于第一文档中所包含的多个描述章节，确定目标内容；所述目标内容包括同一系列中至少一个其他产品的文档所包含的部分描述章节；

根据所述目标内容生成公共复用文件，并基于所述公共复用文件生成同一系列中各个产品分别对应的专属文件；

在所述公共复用文件发生内容变动的情况下，对所述公共复用文件进行检查评审；

基于通过检查评审的所述公共复用文件以及同一系列中各个产品分别对应的专属文件，分别生成各个产品对应的文档；其中，

所述根据所述目标内容生成公共复用文件，并基于所述公共复用文件生成同一系列中各个产品分别对应的专属文件之后，还包括：

在同一系列中的产品数量增加的情况下，将所述公共复用文件中的各个描述章节与新增的产品进行匹配；

在所述公共复用文件中所包含的至少一个描述章节的部分功能或特性与新增的产品不匹配的情况下，将不匹配的描述章节进行拆分，得到多个碎片化文件；

基于与新增的产品匹配的一部分碎片化文件更新所述公共复用文件；

基于与新增的产品不匹配的另一部分碎片化文件，更新原有的各个产品分别对应的专属文件。

2.根据权利要求1所述的文档生成方法，其特征在于，所述基于第一文档中所包含的多个描述章节，确定目标内容，包括：

基于第一文档中所包含的多个描述章节，根据预设目标筛选规则筛选得到部分描述章节；

根据筛选出的部分描述章节生成所述目标内容。

3.根据权利要求1所述的文档生成方法，其特征在于，所述基于第一文档中所包含的多个描述章节，确定目标内容，还包括：

基于第一文档中所包含的多个描述章节以及同一系列中至少一个其他产品的文档所包含的多个描述章节，确定重复存在的部分描述章节；

基于重复存在的部分描述章节生成所述目标内容。

4.根据权利要求1所述的文档生成方法，其特征在于，所述将不匹配的描述章节进行拆分，得到多个碎片化文件之后，还包括：

基于与新增的产品不匹配的另一部分碎片化文件，生成或更新部分复用文件；所述部分复用文件包含至少一个特定描述章节，所述特定描述章节为同一系列中至少两个产品的文档所包含的描述章节。

5.根据权利要求4所述的文档生成方法，其特征在于，所述公共复用文件与所述部分复用文件存储于公共文件数据库。

6.根据权利要求1-5中任一项所述的文档生成方法，其特征在于，所述目标内容所包含的每个描述章节为同一系列中的每个产品的文档均包含的描述章节。

7.一种文档生成装置，其特征在于，包括：

确定模块，用于基于第一文档中所包含的多个描述章节，确定目标内容；所述目标内容包括同一系列中至少一个其他产品的文档所包含的部分描述章节；

公共模块，用于根据所述目标内容生成公共复用文件，并基于所述公共复用文件生成同一系列中各个产品分别对应的专属文件；

检评模块，用于在所述公共复用文件发生内容变动的情况下，对所述公共复用文件进行检查评审；

生成模块，用于基于通过检查评审的所述公共复用文件以及同一系列中各个产品分别对应的专属文件，分别生成各个产品对应的文档；

所述装置还包括：

匹配模块，用于在同一系列中的产品数量增加的情况下，将公共复用文件中的各个描述章节与新增的产品进行匹配；

碎片化模块，用于在公共复用文件中所包含的至少一个描述章节的部分功能或特性与新增的产品不匹配的情况下，将不匹配的描述章节进行拆分，得到多个碎片化文件；

第一更新模块，用于基于与新增的产品匹配的一部分碎片化文件更新公共复用文件；

第二更新模块，用于基于与新增的产品不匹配的另一部分碎片化文件，更新原有的各个产品分别对应的专属文件。

8.一种文档生成设备，其特征在于，包括：处理器以及存储有计算机程序指令的存储器；

所述处理器执行所述计算机程序指令时实现如权利要求1-6任意一项所述的文档生成方法的步骤。

9.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质上存储有计算机程序指令，所述计算机程序指令被处理器执行时实现如权利要求1-6任意一项所述的文档生成方法的步骤。

10.一种计算机程序产品，其特征在于，所述计算机程序产品中的指令被处理器执行时实现如权利要求1-6任意一项所述的文档生成方法的步骤。