文档生成方法及装置制造方法及图纸

本申请实施例提供一种文档生成方法及装置。文档生成方法包括：确定需要生成文档的目标产品以及需要生成的目标文档类型；根据所述目标产品的配置宏文件，从配置宏集合中选择所述目标产品包含的配置宏；从所述目标文档类型对应的基准数据集合中，选择与所述目标产品包含的配置宏匹配的基准数据；根据与所述目标产品包含的配置宏匹配的基准数据，生成所述目标产品所需的文档。采用本申请实施例可自动生成产品所需的文档，不仅效率较高，而且有利于降低文档的出错概率。

【技术实现步骤摘要】
文档生成方法及装置
本申请涉及通信
，尤其涉及一种文档生成方法及装置。
技术介绍
在互联网、通信等领域中，无论是硬件产品还是软件产品在发布时，一般会同时发布相关文档。这些文档有助于使用者了解与产品相关的信息，例如产品功能、使用方法、配置指南或系统日志等。在现有技术中，由开发人员编写需要随产品同时发布的相关文档，编写人员编写完成之后交由测试人员负责测试，测试通过后再交由文档人员进行复核与验收，最后随同产品一起发布。这种文档发布方式的效率较低，而且随着产品频繁地更新换代，文档数量较多，所以文档的错误率也相对较高。
技术实现思路
本申请的多个方面提供一种文档生成方法及装置，用以提高文档生成效率，降低文档错误率。本申请实施例提供一种文档生成方法，包括：确定需要生成文档的目标产品以及需要生成的目标文档类型；根据所述目标产品的配置宏文件，从配置宏集合中选择所述目标产品包含的配置宏；从所述目标文档类型对应的基准数据集合中，选择与所述目标产品包含的配置宏匹配的基准数据；根据与所述目标产品包含的配置宏匹配的基准数据，生成所述目标产品所需的文档。在一可选实施方式中，所述确定需要生成文档的目标产品以及需要生成的目标文档类型，包括：根据用户的访问请求，向所述用户展示多个标签页，每个标签页对应一个文档类型；响应于所述用户从所述多个标签页中选择目标标签页的操作，确定所述目标标签页对应的文档类型为所述目标文档类型；以及在所述目标标签页上展示产品列表，以供所述用户从中选择所述目标产品；响应于所述用户从所述产品列表中选择所述目标产品的操作，确定所述目标产品。在一可选实施方式中，所述目标标签页包括文档导出控件；所述在所述目标标签页上展示产品列表，包括：响应于所述用户点击所述文档导出控件的操作，在所述目标标签页上展示所述产品列表。在一可选实施方式中，所述从所述目标文档类型对应的基准数据集合中，选择与所述目标产品包含的配置宏匹配的基准数据，包括：将所述基准数据集合中的基准数据全部导出至一列表型文件中；根据所述目标产品包含的配置宏与基准数据的匹配情况，为所述列表型文件中的每个基准数据添加选中标记或未选中标记；从所述列表型文件中，选择带有选中标记的基准数据。在一可选实施方式中，所述根据与所述目标产品包含的配置宏匹配的基准数据，生成所述目标产品所需的文档，包括：获取所述目标文档类型对应的文档模板；将与所述目标产品包含的配置宏匹配的基准数据添加至所述文档模板中，以获得所述目标产品所需的文档。在一可选实施方式中，在根据所述目标产品的配置宏文件，从配置宏集合中选择所述目标产品包含的配置宏之前，所述方法还包括：每当有新产品出现时，根据所述新产品包含的配置宏，以增量方式更新所述配置宏集合；和/或每当用户自定义配置宏时，根据所述用户自定义的配置宏，以增量方式更新所述配置宏集合。在一可选实施方式中，在从所述目标文档类型对应的基准数据集合中，选择与所述目标产品包含的配置宏匹配的基准数据之前，所述方法还包括：每当有新产品出现时，根据所述新产品所涉及的与所述目标文档类型对应的基准数据，以增量方式更新所述基准数据集合；和/或每当用户自定义与所述目标文档类型对应的基准数据时，根据所述用户自定义的与所述目标文档类型对应的基准数据，以增量方式更新所述基准数据集合。本申请实施例还提供一种文档生成装置，包括：确定模块，用于确定需要生成文档的目标产品以及需要生成的目标文档类型；第一选择模块，用于根据所述目标产品的配置宏文件，从配置宏集合中选择所述目标产品包含的配置宏；第二选择模块，用于从所述目标文档类型对应的基准数据集合中，选择与所述目标产品包含的配置宏匹配的基准数据；生成模块，用于根据与所述目标产品包含的配置宏匹配的基准数据，生成所述目标产品所需的文档。本申请实施例还提供一种电子设备，包括：存储器和处理器；所述存储器，用于存储程序；所述处理器，用于执行所述存储器中的所述程序，以用于：确定需要生成文档的目标产品以及需要生成的目标文档类型；根据所述目标产品的配置宏文件，从配置宏集合中选择所述目标产品包含的配置宏；从所述目标文档类型对应的基准数据集合中，选择与所述目标产品包含的配置宏匹配的基准数据；根据与所述目标产品包含的配置宏匹配的基准数据，生成所述目标产品所需的文档。在本申请实施例中，首先，确定需要生成文档的目标产品以及需要生成的目标文档类型；基于目标产品的配置宏文件，从配置宏集合中选择目标产品包含的配置宏，进而从目标文档类型对应的基准数据集合中，选择与目标产品包含的配置宏匹配的基准数据，由选择出的基准数据，生成目标产品所需的文档。由此可见，本申请实施例可基于产品的配置宏文件以及配置宏与基准数据之间的匹配关系，自动生成产品所需的文档，不仅效率较高，而且有利于降低文档的出错概率。附图说明此处所说明的附图用来提供对本申请的进一步理解，构成本申请的一部分，本申请的示意性实施例及其说明用于解释本申请，并不构成对本申请的不当限定。在附图中：图1a为本申请一实施例提供的文档生成方法的流程示意图；图1b为本申请另一实施例提供的通过列表型文件选择基准数据的状态示意图；图2为本申请另一实施例提供的文档生成方法的流程示意图；图3a为本申请又一实施例提供的文档生成方法的流程示意图；图3b为本申请又一实施例提供的CREF文档的部分示意图；图4a为本申请又一实施例提供的文档生成方法的流程示意图；图4b为本申请又一实施例提供的SCG文档的部分示意图；图5为本申请又一实施例提供的文档生成装置的结构示意图；图6为本申请又一实施例提供的电子设备的结构示意图。具体实施方式为使本申请的目的、技术方案和优点更加清楚，下面将结合本申请具体实施例及相应的附图对本申请技术方案进行清楚、完整地描述。显然，所描述的实施例仅是本申请一部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。图1a为本申请一实施例提供的文档生成方法的流程示意图。如图1a所示，所述方法包括：101、确定需要生成文档的目标产品以及需要生成的目标文档类型。102、根据目标产品的配置宏文件，从配置宏集合中选择目标产品包含的配置宏。103、从目标文档类型对应的基准数据集合中，选择与目标产品包含的配置宏匹配的基准数据。104、根据与目标产品包含的配置宏匹配的基准数据，生成目标产品所需的文档。在实际应用中，根据应用场景或应用需求的不同，经常需要为产品生成相应文档。例如，在发布产品时，需要为产品生成随同产品一起发布的文档。例如，在验证产品时，需要生成可辅助验证产品的验证文档。这些文档都是以产品为依据的。产品不同，需要生成的文档也会有所不同。另外，与产品相关的文档可能会有多种类型。一般来说，根据产品、应用需求或应用场景的不同，需要生成的文档类型也会有所不同。以通信领域的产品为例，一般会涉及软件产品功能规格(Specification，SPEC)文档、命令参考(CommandReference，CREF)文档、产品配置指南(SampleConfigurationGuide，SCG)文档、管理信息库(ManagementInformationBase，MIB)文档、系本文档来自技高网...

【技术保护点】
一种文档生成方法，其特征在于，包括：确定需要生成文档的目标产品以及需要生成的目标文档类型；根据所述目标产品的配置宏文件，从配置宏集合中选择所述目标产品包含的配置宏；从所述目标文档类型对应的基准数据集合中，选择与所述目标产品包含的配置宏匹配的基准数据；根据与所述目标产品包含的配置宏匹配的基准数据，生成所述目标产品所需的文档。

【技术特征摘要】
1.一种文档生成方法，其特征在于，包括：确定需要生成文档的目标产品以及需要生成的目标文档类型；根据所述目标产品的配置宏文件，从配置宏集合中选择所述目标产品包含的配置宏；从所述目标文档类型对应的基准数据集合中，选择与所述目标产品包含的配置宏匹配的基准数据；根据与所述目标产品包含的配置宏匹配的基准数据，生成所述目标产品所需的文档。2.根据权利要求1所述的方法，其特征在于，所述确定需要生成文档的目标产品以及需要生成的目标文档类型，包括：根据用户的访问请求，向所述用户展示多个标签页，每个标签页对应一个文档类型；响应于所述用户从所述多个标签页中选择目标标签页的操作，确定所述目标标签页对应的文档类型为所述目标文档类型；以及在所述目标标签页上展示产品列表，以供所述用户从中选择所述目标产品；响应于所述用户从所述产品列表中选择所述目标产品的操作，确定所述目标产品。3.根据权利要求2所述的方法，其特征在于，所述目标标签页包括文档导出控件；所述在所述目标标签页上展示产品列表，包括：响应于所述用户点击所述文档导出控件的操作，在所述目标标签页上展示所述产品列表。4.根据权利要求1所述的方法，其特征在于，所述从所述目标文档类型对应的基准数据集合中，选择与所述目标产品包含的配置宏匹配的基准数据，包括：将所述基准数据集合中的基准数据全部导出至一列表型文件中；根据所述目标产品包含的配置宏与基准数据的匹配情况，为所述列表型文件中的每个基准数据添加选中标记或未选中标记；从所述列表型文件中，选择带有选中标记的基准数据。5.根据权利要求1所述的方法，其特征在于，所述根据与所述目标产品包含的配置宏匹配的基准数据，生成所述目标产品所需的文档，包括：获取所述目标文档类型对应的文档模板；将与所述目标产品包含的配置宏匹配的基准数据添加至所述文档模板中，以获得所述目标产品所需的文档。6.根据权利要求1-5任一项所述的方法，其特征在于，在根据所述目标产品的配置宏文件，从配置宏集合中选择所述目标产品包含的配置宏之前，所述方法还包括：每当有新产品出现时，根据所述新产品包含的配置宏，以增量方式更新所述配置宏集合；和/或每当用户自定义配置宏时，根据所述用户自定义的配置宏，以增量方式更新所述配置宏集合。7.根据权利要求1-5任一项所述的方法，其特征在于，在从所述目标文档类型对应的基准数据集合中，选择与所述目标产品包含的配置宏匹配的基准数据之前，所述方法还包括：每当有新产品出现时，根据所述新产品所涉及的与所述目标文档类型对应的基准数据，以增量方式更新所述基准数据集合；和/或每当用户自定义与所述目标文档类型对应的基准数据时，根据所述用户自定义的与所述目标文档类型对应的基准数据，以增量方式更新所述基准数据集合。8.根据权利要求1-5任一项所述的方法，其特征在于，所述目标文档类型为软件规格SPEC类型，所述基准数据集合包括产品功能描述数据，所述目标产品所需的文档为SPEC文档；或者所述文档类型为命令参考CREF类型，所...

【专利技术属性】
技术研发人员：郑德辉，
申请(专利权)人：锐捷网络股份有限公司，
类型：发明
国别省市：福建,35