CN111783403B - 一种文档提供方法、设备及介质 - Google Patents

Abstract

本发明公开了一种文档提供方法、设备及介质，包括：确定产品提供的各功能，以及各功能对应的文档，其中，产品的整个说明文档由各功能对应的文档构成；确定提供给接入方的产品中包含的功能；在包含的功能中，根据需接入方了解的功能提供该功能对应的文档。采用本发明，克服了大而全文档带来的不足，能够针对每一个接入方提供最精准的文档，由于文档是个性化定制的，因此能够明显提升接入方的客户感知。

Description

一种文档提供方法、设备及介质

技术领域

本发明涉及无线通信技术领域，特别涉及一种文档提供方法、设备及介质。

背景技术

产品说明文档是指以文档的方式对产品进行表述，使人认识、了解到某产品。其基本特点有真实性、科学性、条理性、通俗性和实用性。

产品说明文档是生产者向消费者全面、明确地介绍产品名称、用途、性质、性能、原理、构造、规格、使用方法、保养维护、注意事项等内容而写的准确、简明的文档材料。

对于软件产品为主的产品说明文档，目前通常的说明文档提供方案是编写一个大而全的系统说明文档，供接入方(也即用户、消费者)理解。当产品更新时，文档也需要相应的修改，也就意味着需要不断的更新文档版本。

在文档版本的更新过程中，当有多个人，需要修改文档时，需要依次逐个修改，一旦文档发生了修改，需要人工的通知相关方及时关注。

现有技术的不足在于，接入方对这种不能精准提供的系统说明文档的客户感知不佳。

发明内容

本发明提供了一种文档提供方法、设备及介质，用以解决不能精准提供的系统说明文档的问题。

本发明实施例中提供了一种文档提供方法，包括：

确定产品提供的各功能，以及各功能对应的文档，其中，产品的整个说明文档由各功能对应的文档构成；

确定提供给接入方的产品中包含的功能；

在包含的功能中，根据需接入方了解的功能提供该功能对应的文档。

实施中，进一步包括：

在文档更新后，确定该文档对应的功能；

确定需了解该功能的接入方后，通知该接入方文档更新，和/或，向接入方提供更新后的文档。

实施中，按以下方式之一或者其组合通知该接入方文档更新：

确定文档更新后，通知接入方；

确定文档更新后，根据接入方请求进行通知；

确定文档更新后，根据接入方的订阅通知要求进行通知；

确定文档更新后，通知所有需要了解该功能的接入方。

本发明实施例中提供了一种文档提供设备，包括：

处理器，用于读取存储器中的程序，执行下列过程：

确定产品提供的各功能，以及各功能对应的文档，其中，产品的整个说明文档由各功能对应的文档构成；

确定提供给接入方的产品中包含的功能；

在包含的功能中，根据需接入方了解的功能提供该功能对应的文档；

收发机，用于在处理器的控制下接收和发送数据。

实施中，进一步包括：

在文档更新后，确定该文档对应的功能；

确定需了解该功能的接入方后，通知该接入方文档更新，和/或，向接入方提供更新后的文档。

实施中，按以下方式之一或者其组合通知该接入方文档更新：

确定文档更新后，通知接入方；

确定文档更新后，根据接入方请求进行通知；

确定文档更新后，根据接入方的订阅通知要求进行通知；

确定文档更新后，通知所有需要了解该功能的接入方。

本发明实施例中提供了一种文档提供设备，包括：

关系确定模块，用于确定产品提供的各功能，以及各功能对应的文档，其中，产品的整个说明文档由各功能对应的文档构成；

功能确定模块，用于确定提供给接入方的产品中包含的功能；

文档提供模块，用于在包含的功能中，根据需接入方了解的功能提供该功能对应的文档。

实施中，进一步包括：

通知模块，用于在文档更新后，确定该文档对应的功能；确定需了解该功能的接入方后，通知该接入方文档更新，和/或，向接入方提供更新后的文档。

实施中，通知模块进一步用于按以下方式之一或者其组合通知该接入方文档更新：

确定文档更新后，通知接入方；

确定文档更新后，根据接入方请求进行通知；

确定文档更新后，根据接入方的订阅通知要求进行通知；

确定文档更新后，通知所有需要了解该功能的接入方。

本发明实施例中提供了一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现上述文档提供方法。

本发明实施例中提供了一种计算机可读存储介质，所述计算机可读存储介质存储有执行上述文档提供方法的计算机程序。

本发明有益效果如下：

在本发明实施例提供的技术方案中，由于针对产品提供的各功能将文档分成多个部分，而不是提供一个大而全的文档，因而克服了大而全文档带来的不足，也为精准化提供文档打下了基础；

由于文档是根据不同的接入方，按需接入方了解的功能来提供的，因此能够针对每一个接入方提供最精准的文档，由于文档是个性化定制的，因此能够明显提升接入方的客户感知。

附图说明

此处所说明的附图用来提供对本发明的进一步理解，构成本发明的一部分，本发明的示意性实施例及其说明用于解释本发明，并不构成对本发明的不当限定。在附图中：

图1为本发明实施例中文档提供方法实施流程示意图；

图2为本发明实施例中精确文档管理系统结构示意图；

图3为本发明实施例中文档提供设备一结构示意图；

图4为本发明实施例中文档提供设备二结构示意图。

具体实施方式

发明人在发明过程中注意到：

大而全的文档往往是系统所有功能的整体详细说明，而接入方通常并不会全部接入，其往往只关注其中的一部分。大而全的文档本身给接入方带来内容干扰和理解压力，产生不好的体验。

大而全的文档往往不支持，大规模的文档管理，多人同时修改文档时，容易导致相互覆盖。

现有的文档提供方式下，并不具备修改就通知的方式，通常是使用常见的人工通知方式，例如使用电子邮件附带文档，或者通知接入方自行去下载文档。

因此，需要使文档更有针对性，降低接入方的理解成本，直接获取到与自己相关的功能文档；

简化文档管理及更新操作，支持超大规模的文档管理，同时解决多人同时修改文档时，容易导致的相互覆盖问题；

通过主动订阅和自动通知方式，支持自动通知相关的接入方，当文档发生修改时，使各相关的接入方能及时关注到，方便相关接入方及时升级接入方式，及早体验升级带来的系统价值。

同时，随着数字化社会进程的推进，越来越多的公司之间，系统与系统之间产生愈加密切的关联。这些关联关系，部分是通过系统接口相互调用的方式产生；部分通过直接使用对方提供的服务系统产生。这些关联关系中，往往有其内在的复杂度和巨大的实际影响。在关联准备阶段，需要通过系统文档来讲解和说明系统功能。

随着各公司业务的发展，任何一个公司往往能提供系列的系统服务能力，或批量的系统服务接口，当面对一个具体的接入方(客户)时，如何能提供出精确适合的系统文档，就变得尤其必要。

基于此，本发明实施例中提供了一种文档提供方案，下面结合附图对本发明的具体实施方式进行说明。

图1为文档提供方法实施流程示意图，如图所示，可以包括：

步骤101、确定产品提供的各功能，以及各功能对应的文档，其中，产品的整个说明文档由各功能对应的文档构成；

步骤102、确定提供给接入方的产品中包含的功能；

步骤103、在包含的功能中，根据需接入方了解的功能提供该功能对应的文档。

实施中，还可以进一步包括：

在文档更新后，确定该文档对应的功能；

确定需了解该功能的接入方后，通知该接入方文档更新，和/或，向接入方提供更新后的文档。

具体实施中，可以按以下方式之一或者其组合通知该接入方文档更新：

确定文档更新后，通知接入方；

确定文档更新后，根据接入方请求进行通知；

确定文档更新后，根据接入方的订阅通知要求进行通知；

确定文档更新后，通知所有需要了解该功能的接入方。

具体的，在方案中，可以通过在线配置和权限设置的方式，支持为每一个具体接入方生成精确文档。同时支持系统变更通知(服务升级通知)，及时提醒各接入方关注，引导接入方使用系统最新提供的服务能力。

例如：系统提供方S具备1000项系统服务能力(编号为1001～2000)，客户C1需要使用其中的50项服务能力(编号1051～1100)，客户C2需要使用其中的100项服务能力(编号1081～1180)。通过系统自动生成并提供客户C1和客户C2需要的系统说明文档。

编号为1090的文档发生变更升级时，C1和C2能及时接收到文档变更升级通知；

编号为1055的文档发生变更升级时，C1会接收到文档变更升级通知；

编号为1001的文档发生变更升级时，C1和C2都不会接收到文档变更升级通知。

一个具体的实现实例可以如下：

图2为精确文档管理系统结构示意图，如图所示，系统可以包括：

文档内容配置、接入方功能配置、接入方文档生成、文档变更通知几个部分。其中：

文档内容配置：用来配置系统各子功能的文档信息。配置信息包括：功能编码、名称、功能说明文档、上级功能、在同级功能中排序号、内容版本号，是否强制通知。

接入方功能配置：对服务上进行系统文档菜单配置，通过菜单树的方式进行，选中节点，表示该接入方需要获取对应功能节点的文档说明。同时支持配置文档变更订阅。

接入方文档生成：当接入方文档节点配置完成后，支持自动生成系统说明文档，文档编号使用所包含功能文档中的最新版本号。例如：文档中共包括1001、1002、1003三项功能节点，其中1001内容版本号为10000040、1002内容版本号为10000089，1003内容版本号为10000299，则生成的系统说明文档编号为10000299。

文档变更通知功能：某功能的说明文档发生变更时，系统会查询配置有该功能的接入方，根据变更的强制状态及接入方文档变更订阅配置及时通知接入方。

例如：当文档内容变更为强制通知时，所有接入方均可收到该文档变更。文档内容变更为非强制通知时，配置文档变更订阅的接入方，会接收到文档变更通知；未配置文档变更订阅的接入方，不会接收到文档变更通知。

基于同一发明构思，本发明实施例中还提供了文档提供设备、计算机可读存储介质，由于这些设备解决问题的原理与文档提供方法相似，因此这些设备的实施可以参见方法的实施，重复之处不再赘述。

在实施本发明实施例提供的技术方案时，可以按如下方式实施。

图3为文档提供设备一结构示意图，如图所示，设备中包括：

处理器300，用于读取存储器320中的程序，执行下列过程：

确定产品提供的各功能，以及各功能对应的文档，其中，产品的整个说明文档由各功能对应的文档构成；

确定提供给接入方的产品中包含的功能；

在包含的功能中，根据需接入方了解的功能提供该功能对应的文档；

收发机310，用于在处理器300的控制下接收和发送数据。

实施中，进一步包括：

在文档更新后，确定该文档对应的功能；

确定需了解该功能的接入方后，通知该接入方文档更新，和/或，向接入方提供更新后的文档。

实施中，按以下方式之一或者其组合通知该接入方文档更新：

确定文档更新后，通知接入方；

确定文档更新后，根据接入方请求进行通知；

确定文档更新后，根据接入方的订阅通知要求进行通知；

确定文档更新后，通知所有需要了解该功能的接入方。

其中，在图3中，总线架构可以包括任意数量的互联的总线和桥，具体由处理器300代表的一个或多个处理器和存储器320代表的存储器的各种电路链接在一起。总线架构还可以将诸如外围设备、稳压器和功率管理电路等之类的各种其他电路链接在一起，这些都是本领域所公知的，因此，本文不再对其进行进一步描述。总线接口提供接口。收发机310可以是多个元件，即包括发送机和接收机，提供用于在传输介质上与各种其他装置通信的单元。处理器300负责管理总线架构和通常的处理，存储器320可以存储处理器300在执行操作时所使用的数据。

图4为文档提供设备二结构示意图，如图所示，设备中包括：

关系确定模块401，用于确定产品提供的各功能，以及各功能对应的文档，其中，产品的整个说明文档由各功能对应的文档构成；

功能确定模块402，用于确定提供给接入方的产品中包含的功能；

文档提供模块403，用于在包含的功能中，根据需接入方了解的功能提供该功能对应的文档。

实施中，进一步包括：

通知模块404，用于在文档更新后，确定该文档对应的功能；确定需了解该功能的接入方后，通知该接入方文档更新，和/或，向接入方提供更新后的文档。

实施中，通知模块进一步用于按以下方式之一或者其组合通知该接入方文档更新：

确定文档更新后，通知接入方；

确定文档更新后，根据接入方请求进行通知；

确定文档更新后，根据接入方的订阅通知要求进行通知；

确定文档更新后，通知所有需要了解该功能的接入方。

为了描述的方便，以上所述装置的各部分以功能分为各种模块或单元分别描述。当然，在实施本发明时可以把各模块或单元的功能在同一个或多个软件或硬件中实现。

本发明实施例中提供了一种计算机可读存储介质，所述计算机可读存储介质存储有执行上述文档提供方法的计算机程序。

具体可以参见文档提供方法的具体实施方式。

综上所述，本发明实施例提供的技术方案中，将文档生成与接入方功能配置结合，达到精准文档生成的效果。可以实现文档在线管理，为接入方提供其所需的准确文档，降低接入方的理解成本。同时降低了服务提供方的文档管理成本，无需人工加工、人工提供文档给接入方。

更具体的，至少可以实现以下效果之一：

将文档模块化，实现内容标准化配置。

通过配置，支持文档在线编辑管理，线下的方式要求每次更新必须在最新版本的基础上修改，无法多人同时修改由于文档通过系统在线管理和生成可以实现，因而可以支持多人同时修改文档不同模块，支持规模巨大的文档内容管理。

支持系统接入方主动选择(或由被接入方分配)对接的功能和接入的方式后，自动生成接入方相关的精准系统对接文档。

支持接入方，主动订阅文档修改；当文档有较大修改时，支持自动通知所有被影响的相关方。

本领域内的技术人员应明白，本发明的实施例可提供为方法、系统、或计算机程序产品。因此，本发明可采用完全硬件实施例、完全软件实施例、或结合软件和硬件方面的实施例的形式。而且，本发明可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器和光学存储器等)上实施的计算机程序产品的形式。

本发明是参照根据本发明实施例的方法、设备(系统)、和计算机程序产品的流程图和/或方框图来描述的。应理解可由计算机程序指令实现流程图和/或方框图中的每一流程和/或方框、以及流程图和/或方框图中的流程和/或方框的结合。可提供这些计算机程序指令到通用计算机、专用计算机、嵌入式处理机或其他可编程数据处理设备的处理器以产生一个机器，使得通过计算机或其他可编程数据处理设备的处理器执行的指令产生用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的装置。

这些计算机程序指令也可存储在能引导计算机或其他可编程数据处理设备以特定方式工作的计算机可读存储器中，使得存储在该计算机可读存储器中的指令产生包括指令装置的制造品，该指令装置实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能。

这些计算机程序指令也可装载到计算机或其他可编程数据处理设备上，使得在计算机或其他可编程设备上执行一系列操作步骤以产生计算机实现的处理，从而在计算机或其他可编程设备上执行的指令提供用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的步骤。

显然，本领域的技术人员可以对本发明进行各种改动和变型而不脱离本发明的精神和范围。这样，倘若本发明的这些修改和变型属于本发明权利要求及其等同技术的范围之内，则本发明也意图包含这些改动和变型在内。

Claims (10)

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

确定产品提供的各功能，以及各功能对应的文档，其中，产品的整个说明文档由各功能对应的文档构成；

确定提供给接入方的产品中包含的功能；

在包含的功能中，根据需接入方了解的功能提供该功能对应的文档；

其中，通过在线配置和权限设置的方式，支持为每一个具体接入方生成精确文档；

通过精确文档管理系统结构来管理文档，所述精确文档管理系统结构包括：

文档内容配置：用来配置系统各子功能的文档信息；

接入方功能配置：对服务上进行系统文档菜单配置，通过菜单树的方式进行，选中节点，表示该接入方需要获取对应功能节点的文档说明，同时支持配置文档变更订阅；

接入方文档生成：当接入方文档节点配置完成后，支持自动生成系统说明文档，文档编号使用所包含功能文档中的最新版本号；

文档变更通知功能：某功能的说明文档发生变更时，系统会查询配置有该功能的接入方，根据变更的强制状态及接入方文档变更订阅配置及时通知接入方。

2.如权利要求1所述的方法，其特征在于，进一步包括：

在文档更新后，确定该文档对应的功能；

确定需了解该功能的接入方后，通知该接入方文档更新，和/或，向接入方提供更新后的文档。

3.如权利要求2所述的方法，其特征在于，按以下方式之一或者其组合通知该接入方文档更新：

确定文档更新后，通知接入方；

确定文档更新后，根据接入方请求进行通知；

确定文档更新后，根据接入方的订阅通知要求进行通知；

确定文档更新后，通知所有需要了解该功能的接入方。

4.一种文档提供设备，其特征在于，包括：

处理器，用于读取存储器中的程序，执行下列过程：

确定产品提供的各功能，以及各功能对应的文档，其中，产品的整个说明文档由各功能对应的文档构成；

确定提供给接入方的产品中包含的功能；

在包含的功能中，根据需接入方了解的功能提供该功能对应的文档；

收发机，用于在处理器的控制下接收和发送数据；

其中，通过在线配置和权限设置的方式，支持为每一个具体接入方生成精确文档；

通过精确文档管理系统结构来管理文档，所述精确文档管理系统结构包括：

文档内容配置：用来配置系统各子功能的文档信息；

接入方功能配置：对服务上进行系统文档菜单配置，通过菜单树的方式进行，选中节点，表示该接入方需要获取对应功能节点的文档说明，同时支持配置文档变更订阅；

接入方文档生成：当接入方文档节点配置完成后，支持自动生成系统说明文档，文档编号使用所包含功能文档中的最新版本号；

文档变更通知功能：某功能的说明文档发生变更时，系统会查询配置有该功能的接入方，根据变更的强制状态及接入方文档变更订阅配置及时通知接入方。

5.如权利要求4所述的设备，其特征在于，进一步包括：

在文档更新后，确定该文档对应的功能；

确定需了解该功能的接入方后，通知该接入方文档更新，和/或，向接入方提供更新后的文档。

6.如权利要求5所述的设备，其特征在于，按以下方式之一或者其组合通知该接入方文档更新：

确定文档更新后，通知接入方；

确定文档更新后，根据接入方请求进行通知；

确定文档更新后，根据接入方的订阅通知要求进行通知；

确定文档更新后，通知所有需要了解该功能的接入方。

7.一种文档提供设备，其特征在于，包括：

关系确定模块，用于确定产品提供的各功能，以及各功能对应的文档，其中，产品的整个说明文档由各功能对应的文档构成；

功能确定模块，用于确定提供给接入方的产品中包含的功能；

文档提供模块，用于在包含的功能中，根据需接入方了解的功能提供该功能对应的文档；

其中，通过在线配置和权限设置的方式，支持为每一个具体接入方生成精确文档；

通过精确文档管理系统结构来管理文档，所述精确文档管理系统结构包括：

文档内容配置：用来配置系统各子功能的文档信息；

接入方功能配置：对服务上进行系统文档菜单配置，通过菜单树的方式进行，选中节点，表示该接入方需要获取对应功能节点的文档说明，同时支持配置文档变更订阅；

接入方文档生成：当接入方文档节点配置完成后，支持自动生成系统说明文档，文档编号使用所包含功能文档中的最新版本号；

文档变更通知功能：某功能的说明文档发生变更时，系统会查询配置有该功能的接入方，根据变更的强制状态及接入方文档变更订阅配置及时通知接入方。

8.如权利要求7所述的设备，其特征在于，进一步包括：

通知模块，用于在文档更新后，确定该文档对应的功能；确定需了解该功能的接入方后，通知该接入方文档更新，和/或，向接入方提供更新后的文档。

9.如权利要求8所述的设备，其特征在于，通知模块进一步用于按以下方式之一或者其组合通知该接入方文档更新：

确定文档更新后，通知接入方；

确定文档更新后，根据接入方请求进行通知；

确定文档更新后，根据接入方的订阅通知要求进行通知；

确定文档更新后，通知所有需要了解该功能的接入方。

10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质存储有执行权利要求1至权利要求3任一所述方法的计算机程序。

Images