CN104008089A

CN104008089A - 用于验证文档的方法和系统

Info

Publication number: CN104008089A
Application number: CN201410057276.3A
Authority: CN
Inventors: P·S·多尼斯; G·D·拉斯姆森
Original assignee: International Business Machines Corp
Current assignee: International Business Machines Corp
Priority date: 2013-02-25
Filing date: 2014-02-20
Publication date: 2014-08-27
Anticipated expiration: 2034-02-20
Also published as: US9436684B2; US20140372391A1; US8954405B2; CN104008089B; US20140244605A1

Abstract

本发明涉及一种用于验证文档的方法和系统。至少一个处理器可以确定记录至少一个软件功能的多个文档主题中的一个或多个文档主题中的一个或多个问题，所述确定至少基于将一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题。响应于确定所述一个或多个问题，可以将一个或多个表项插入问题报告，其中所述一个或多个表项包括有关所述一个或多个问题的信息。

Description

用于验证文档的方法和系统

技术领域

本公开涉及文档验证，更具体地说，涉及基于验证文档主题的内容和元数据而生成问题报告。

背景技术

应用模型可以定义到特定产品的Web服务接口。应用模型可以包括在语义上定义Web服务接口的语义结构，并且还可以包括记录Web服务接口的文档主题。开发人员可以为Web服务接口定义新的语义结构，并且可以为新的语义结构提供初始文档主题。随后，信息开发人员（例如，技术文档编写人员）可以提供有关相同的新语义结构的面向客户的文档主题。当开发人员针对Web服务接口定义新的语义结构或修改先前定义的语义结构时，可以修改现有的文档主题，并且可以添加新的文档主题。当创建和修改语义结构时，以及当创建和修改文档主题时，文档主题中的错误和不一致性可能难以检测。

发明内容

在一个实例中，本公开涉及一种用于针对至少一个软件功能验证文档的方法。所述方法可以包括：由至少一个处理器确定记录至少一个软件功能的多个文档主题中的一个或多个文档主题中的一个或多个问题，所述确定至少基于将一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题，所述应用包括以下操作中的一个或多个：将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据，以便针对所述至少一个软件功能使用语义模型交叉引用所述多个文档主题中的所述一个或多个文档主题的所述元数据，将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的内容，以便针对所述至少一个软件功能使用所述语义模型交叉引用所述多个文档主题中的所述一个或多个文档主题的所述内容，以及将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据和一个或多个相关文档主题的元数据，以便测试所述多个文档主题中的所述一个或多个文档主题的所述元数据与所述一个或多个相关文档主题的所述元数据之间的一致性。所述方法还可以包括：响应于确定所述一个或多个问题，由所述至少一个处理器将一个或多个表项插入问题报告，其中所述一个或多个表项包括有关所述一个或多个问题的信息。

在另一个实例中，本公开涉及一种系统。所述系统可以包括至少一个处理器。所述系统还可以包括存储器。所述系统还可以包括模型处理模块，其存储在所述存储器中并可由所述至少一个处理器操作以便：由至少一个处理器确定记录至少一个软件功能的多个文档主题中的一个或多个文档主题中的一个或多个问题，所述确定至少基于将一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题，所述应用包括以下操作中的一个或多个：将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据，以便针对所述至少一个软件功能使用语义模型交叉引用所述多个文档主题中的所述一个或多个文档主题的所述元数据，将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的内容，以便针对所述至少一个软件功能使用所述语义模型交叉引用所述多个文档主题中的所述一个或多个文档主题的所述内容，以及将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据和一个或多个相关文档主题的元数据，以便测试所述多个文档主题中的所述一个或多个文档主题的所述元数据与所述一个或多个相关文档主题的所述元数据之间的一致性；以及响应于确定所述一个或多个问题，将一个或多个表项插入问题报告，其中所述一个或多个表项包括有关所述一个或多个问题的信息。

在另一个实例中，本公开涉及一种包含指令的计算机可读存储介质。当由至少一个处理器执行时，所述指令可以导致所述至少一个处理器执行操作。所述操作可以包括：由至少一个处理器确定记录至少一个软件功能的多个文档主题中的一个或多个文档主题中的一个或多个问题，所述确定至少基于将一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题，所述应用包括以下操作中的一个或多个：将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据，以便针对所述至少一个软件功能使用语义模型交叉引用所述多个文档主题中的所述一个或多个文档主题的所述元数据，将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的内容，以便针对所述至少一个软件功能使用所述语义模型交叉引用所述多个文档主题中的所述一个或多个文档主题的所述内容，以及将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据和一个或多个相关文档主题的元数据，以便测试所述多个文档主题中的所述一个或多个文档主题的所述元数据与所述一个或多个相关文档主题的所述元数据之间的一致性。所述操作还可以包括：响应于确定所述一个或多个问题，由所述至少一个处理器将一个或多个表项插入问题报告，其中所述一个或多个表项包括有关所述一个或多个问题的信息。

在下面的附图和说明书中给出了本公开的一个或多个实例的细节。从说明书和附图以及权利要求，本公开的其它特性、目标和优点将显而易见。

附图说明

图1是示出根据本公开的某些方面的提供服务的一个实例服务器以及访问所提供的服务的一个实例客户端的框图；

图2是示出根据本公开的某些方面的产生服务描述和文档文件的一个实例设备的框图；

图3是示出根据本公开的某些方面的用于针对实例文档主题验证和生成文档的一个实例系统的框图；

图4是示出根据本公开的某些方面的一个实例计算设备的框图；

图5是示出根据本公开的某些方面的用于验证文档主题的一个实例过程的流程图。

具体实施方式

一般而言，本公开涉及验证诸如软件功能文档之类的文档主题。例如，可以通过使用Web服务接口的对应语义结构验证文档中的文档主题的内容和与文档主题关联的元数据，验证Web服务接口的文档，以便确定文档主题与对应的语义结构或其它相关文档主题之间的任何不一致性。本技术利用有关文档主题提供者的信息以及有关文档主题使用者的信息，以便应用特定的业务规则，从而降低错误和缺少的内容的可能性。总的来说，这可以为所有使用者提供所产生文档的更高级别的准确性、完整性和质量。

文档主题可以包含元数据或者以其它方式与元数据关联，元数据提供有关关联的文档主题的某些信息。例如，元数据可以包括有关以下各项的信息：主题类型、主题ID、主题提供者、主题使用者以及关联文档主题的修改日期。在某些实例中，对Web服务接口进行建模的语义结构可以在语义上定义Web服务接口提供的用于访问Web服务的方法。例如，对于Web服务接口提供的方法，语义结构可以在语义上定义该方法的参数、该方法接受和返回的类型等。记录Web服务接口的指定功能的文档主题可以对应于一种语义结构，该语义结构在语义上定义Web服务接口的该功能。可以根据一组业务规则，将文档主题所关联的元数据与对应的语义结构相比较。例如，如果在元数据中将文档主题的主题类型设置为过时，则可以检查对应的语义结构以便判定对应的语义结构是否也设置为过时。相反地，如果将语义结构设置为过时，则可以检查与对应文档主题关联的元数据以便判定是否在元数据中将文档主题设置为过时。还可以将元数据与相关文档主题中的元数据相比较。

还可以使用与文档主题关联的元数据判定文档主题是否包括在生成的文档文件中。例如，如果生成的文档文件指向客户端，但与文档主题关联的元数据指定文档主题指向内部开发人员，则不可以将该文档主题包括在生成的文档文件中。

通过使用对应的语义结构验证与文档主题关联的元数据，可以在不断修订语义模型和文档主题时更快速和准确地检测文档主题中的错误和不一致性。此外，通过使用与文档主题关联的元数据判定是否包括关联的文档主题，可以针对不同的受众定制文档。

图1是示出根据本公开的某些方面的提供服务的一个实例服务器以及访问所提供的服务的一个实例客户端的框图。如图1中所示，服务器104可以包括服务提供者110和服务接口106，该服务接口用于访问服务提供者110提供的软件功能。在某些实例中，服务器104可以是Web服务器，服务提供者110可以是Web应用，服务接口106可以是Web服务接口。服务器104可以产生服务描述108，该服务描述108将描述用于访问服务提供者110的软件功能的接口。在某些实例中，如果服务提供者110是Web应用，则服务描述108可以使用Web服务描述语言（WSDL）编写，以便描述服务提供者110的接口。一个或多个客户端102可以使用服务描述108确定如何与服务提供者110的接口交互，以便访问服务提供者110的软件功能。例如，一个或多个客户端102可以至少部分地基于服务提供者110的接口的服务描述108所提供的描述，生成调用并将其发送到服务提供者110的接口以便使得服务提供者110能够执行操作。

图2是示出根据本公开的某些方面的产生服务描述和文档文件的一个实例设备的框图。尽管根据Web服务接口描述图2，但应该理解，图2中所示的实例设备能够独立于Web服务接口，针对各种软件功能产生服务描述和文档文件。如图2中所示，设备202可以是服务器或任何其它合适的计算设备，其可以包括模型处理模块218和文档生成模块224。模型处理模块218可以处理语义模型208，以便生成可以由模型开发人员和其它内部使用者使用的服务描述216、问题报告222和文档。文档生成模块224可以处理由模型处理模块218生成的文档，以便生成可以由外部用户（例如，使用服务描述216的应用的开发人员）使用的文档文件220。

语义模型208可以定义Web服务接口，并且可以包括对Web服务接口进行语义建模的语义结构212A-212N（“语义结构212”）。语义结构212可以包括记录Web服务接口的文档主题210A-210N（“文档主题210”）。例如，语义结构212A可以包括文档主题210A，该文档主题记录由关联的语义结构212A定义的Web服务功能。文档主题210可以包括相应的文档内容206A-206N（“文档内容206”）和元数据214A-214N（“元数据214”）。文档内容206可以是解释Web服务接口的一个或多个软件功能的书面文本。元数据214可以描述文档主题210中的文档内容206。在某些实例中，可以在概念上使用元数据214A“标记”文档主题（例如文档主题210A）。

模型处理模块218可以处理语义模型208，以便产生服务描述216、问题报告222和内部文档。模型处理模块218可以至少基于对Web服务接口进行语义建模的应用模型208，生成服务描述216。服务描述216可以是Web服务接口以及客户端如何可以定址和访问这些接口的机器可读描述。在某些实例中，服务描述216可以是可由SOAP工具包使用的WSDL文件。

模型处理模块218还可以验证文档主题210以便检测问题，例如常见错误、遗漏以及文档主题（例如文档主题210A）和定义由关联文档主题记录的软件功能的关联语义结构（例如包括文档主题210A的语义结构212A）之间的差异，方式是将一组业务规则应用于与文档主题210A关联的元数据214A以便确定任何此类问题。此类业务规则可以使用描述由文档主题210A记录的Web服务接口的软件功能的语义结构212A，验证与文档主题210A关联的元数据214A，以便判定文档内容206是否在语义上与语义结构212A一致。模型处理模块218还可以将文档主题210A与一个或多个相关文档主题相比较。如果在文档主题210A中发现任何问题，则模型处理模块218可以在问题报告222中创建表项，这些表项指示文档主题210A的此类问题。

模型处理模块218可以至少基于语义模型208、文档主题210、元数据214和语义结构212，生成用于模型开发人员和其它内部用户的内部文档文件。模型处理模块224可以基于由模型处理模块218创建的文档，生成用于外部用户的文档文件220。文档文件220可以是Web服务接口以及客户端如何可以定址和访问该接口的人类可读描述。文档文件220的实例可以包括教程、参考资料、更改历史、发行说明等。在某些实例中，可以将文档文件220组织为主题和子主题。

图3是示出根据本公开的某些方面的用于针对实例文档主题验证和生成文档文件的一个实例系统的框图。如图3中所示，模型处理模块306（类似于图2中所示的模型处理模块218）可以验证文档主题302，并且可以将在文档主题302中发现的任何问题添加到问题报告308，并且还可以基于文档主题创建文档。

文档主题302可以包括有关Web服务提供的一个或多个接口或者其它软件功能的信息。由文档主题302记录的Web服务的接口和/或软件功能可以由语义模型在语义上定义，以便语义模型可以包括诸如语义结构312之类的语义结构树，该树在语义上定义接口和/或软件功能。模型处理模块306可以验证文档主题302，方法是将业务规则310应用于与文档主题302关联的元数据304，以便使用语义结构312交叉引用元数据304，从而判定文档主题302是否在语义上与语义结构312一致。通过使用语义结构312验证文档主题302，模型处理模块306可以判定文档主题302是否与语义结构312中的相同主题的语义定义一致。模型处理模块306还可以将文档主题302的内容与语义结构312相比较，并且可以进一步将文档主题302与其它相关文档主题相比较。

元数据304可以包括描述关联的文档主题302的值。文档主题302的元数据304可以包括以下各项的值：日期、主题类型、主题ID、提供者和使用者。元数据304中的日期值可以指示上次修改文档主题302的日期。元数据304中的主题类型值可以指示包含在文档主题302中的信息的类型。在某些实例中，包括在元数据304中的主题类型可以包括达尔文信息类型化体系结构（DITA）类型之一，例如样本、主题、过程等。在某些实例中，主题类型可以是定制的原始主题，它的存在用于简化信息开发。例如，主题类型值可以是“过时通知”原始主题。当模型处理模块306基于文档主题302构建文档文件时，可以使用标准用语将定制的原始主题转换为标准主题。

元数据304中的主题ID值可以用于引用另一个上下文（例如“另请参见”列表或索引）中的文档主题302。在某些实例中，主题ID在所有相关文档主题中可以是唯一的。

元数据304中的提供者值可以指示为文档主题302提供内容的实体。在某些实例中，有效的提供者值可以包括但不限于开发人员、编写人员和生成器。如果提供者是开发人员，则模型开发人员（例如，语义结构312的程序员）可以负责创建文档主题302。如果提供者是编写人员，则信息开发人员可以负责创建文档主题302。如果提供者是生成器，则模型处理模块306可以负责创建文档主题302。

元数据304中的提供者值可以影响基于文档主题302创建文档文件。例如，如果元数据304中的提供者值是开发人员，则它可以指示文档主题302的内容由语义结构312的开发人员提供。因此，文档主题302的内容可能没有足够的质量以便在外部发布。因此，这种文档主题302可以具有由编写人员提供的相关主题。当例如由文档生成模块（例如图2中所示的文档生成模块224）处理语义模型中的文档以便生成文档文件时，可能不会基于文档主题302生成文档文件中的内容。相反，可以使用编写人员提供的相关主题代替文档主题302，以便生成在外部发布到最终用户的文档文件的内容。

元数据304中的使用者值可以包括用户角色，这些用户角色指示文档主题302的预期受众。在某些实例中，有效的使用者值可以包括但不限于开发人员、客户和管理员。如果将使用者表示为开发人员，则文档主题302的预期受众可以是内部开发人员。如果将使用者表示为客户，则文档主题302的预期受众可以是购买产品的应用最终用户、业务用户和/或使用者。如果将使用者表示为管理员，则文档主题的预期受众可以是具有管理员能力和职责的客户。

业务规则310可以包括一个或多个测试，可以针对文档主题302中的元数据304执行这些测试以便判定文档主题302是否具有一个或多个问题，包括一个或多个错误、差异等。一个或多个业务规则310可以包括使用语义结构312验证元数据304（例如通过使用语义结构312交叉引用元数据304），以便确定文档主题302与语义结构312（其对由文档主题302记录的接口进行建模）或其它相关文档主题之间的任何差异，或者使用模型的语义结构验证内容。

一个或多个业务规则可以包括测试多个文档主题中的一个文档主题和语义模型中与该文档主题关联的语义结构之间的一致性的业务规则。一个或多个业务规则可以包括测试多个业务主题中跨其它相关文档主题的一致性的业务规则。文档主题及其相关文档主题可以与相同的语义结构关联。一个或多个业务规则可以包括基于语义模型中的语义结构，测试多个文档主题中的一个文档主题的内容的业务规则。

业务规则310可以测试文档主题302的元数据。例如，业务规则310可以包括测试文档主题302是否在关联的元数据304中缺少其主题ID的业务规则。如果文档主题302缺少其主题ID，则它可能不会由其它文档主题所引用。此外，包括在文档主题302中的任何子主题也可能不会由其它文档主题所引用。在某些实例中，缺少的主题ID可以被视为低严重性问题，该问题被忽略并且不会在问题报告308中报告。

业务规则310还可以包括针对文档主题302中当前查看的每个内容块，测试内容在关联元数据304中具有的日期值是否早于每个查看评论日期的业务规则。如果当前查看的内容具有的日期值晚于每个查看评论日期，则可以在问题报告308中创建记录该问题的表项。问题报告308中的表项（指示文档主题302违反该规则）可以包括哪个角色应负责检查内容的指示。

业务规则310还可以包括测试文档主题302的文档内容中的任何无效引用元素（未示出）的业务规则。如果不正确地形成引用，如果删除或重新定位被引用的语义结构，或者如果文档主题302的同一容器中存在具有相同名称的多个语义结构，则引用可能无效。如果在文档主题302中发现无效引用元素，则可以在问题报告308表项中创建记录该问题的表项。

业务规则310还可以测试跨相关文档主题的一致性。如果文档主题与同一语义结构312关联，则这些文档主题相关。例如，业务规则310可以包括测试文档主题302是否由模型开发人员提供（即，通过检查包含的元数据304中的提供者值）的业务规则。如果文档主题302由模型开发人员提供，则业务规则可以测试由信息开发人员（例如，技术文档编写人员）提供的相关主题与相同的使用者共存。如上面讨论的，如果文档主题由模型开发人员提供，则可以使用由信息开发人员提供的相关文档主题替换该文档主题（如果发布文档主题）。如果文档主题302由模型开发人员提供，但由信息开发人员提供的相关主题不与相同的文档使用者共存，则可以在问题报告308中创建记录该差异的表项，以便指示信息开发人员应该创建相关主题。

同样，业务规则310还可以包括测试文档主题302是否由信息开发人员提供的业务规则。如果文档主题302由信息开发人员提供，则业务规则可以测试文档主题302是否具有晚于由模型开发人员提供的其相关文档主题的日期。如果文档主题302由信息开发人员提供，但由模型开发人员提供的其相关文档主题之一具有更晚的日期，则可以在问题报告308中创建记录该差异的表项，从而指示信息开发人员可能需要判定由模型开发人员提供的已更新内容是否也应可用于非开发受众。

业务规则310可以包括测试文档主题302和与该文档主题关联的语义结构312之间的一致性的业务规则。例如，业务规则310可以包括使用语义结构312验证文档主题302的业务规则，以便测试与语义结构312中弃用的语义结构关联的至少一个文档主题302是弃用的原始主题。相反，业务规则310还可以包括使用语义结构312验证文档主题302的业务规则，以便如果与语义结构312关联的文档主题302是弃用的原始主题，则测试语义结构312是否被弃用。

业务规则310还可以包括使用语义结构312验证文档主题302，以便测试与过时的语义结构312关联的至少一个文档主题302是过时的原始主题的业务规则。相反地，业务规则310还可以包括使用语义结构312验证文档主题302的业务规则，以便如果与语义结构312关联的文档主题302是过时的原始主题，则测试语义结构312是否过时，方法是判定与文档主题302关联的元数据304是否包括文档主题302是过时的原始主题的指示。

业务规则310还可以包括在问题报告308中创建表项的业务规则，该表项报告任何被保留的主题（例如，被保留以供将来使用）。

如果模型处理模块306基于将业务规则310应用于关联的元数据304和/或文档内容而确定文档主题302中具有问题，则模型处理模块306可以在问题报告308中插入记录问题的表项。问题报告308中的表项（记录文档主题302中的问题）可以包括文档主题302的主题类型、主题ID、主题提供者、主题使用者、对相关工作单的引用，以及最可能能够解决问题的团队的指示。模型开发人员和信息开发人员可以查看问题报告308以便确定文档主题302和语义模型312之间的问题，并且可以被分派解决这些差异的任务。

图4是示出根据本公开的某些方面的一个实例计算设备的框图。如图4的实例中所示，计算设备400（类似于图1中所示的服务器104和图2中所示的服务器202）可以包括一个或多个处理器402、一个或多个输入设备404、一个或多个通信单元406、一个或多个输出设备408以及一个或多个存储设备414。在该实例中，计算设备400的存储设备414可以包括操作系统416、服务提供者418、语义模型420、语义结构422、文档主题424、模型处理模块428、业务规则430、问题报告432以及文档生成模块434。通信通道412可以互连组件402、404、406、408和414中的每一个，以便实现组件间通信（物理上、通信上和/或操作上）。在某些实例中，通信通道412可以包括系统总线、网络连接、进程间通信数据结构，或者用于传送数据的任何其它方法。

计算设备400的一个或多个输入设备404可以接收输入。输入的实例为触觉、音频和视频输入。在一个实例中，计算设备400的输入设备404包括存在敏感显示器、触摸敏感屏幕、鼠标、键盘、语音响应系统、摄像机、麦克风，或者用于检测来自人类或机器的输入的任何其它类型的设备。

计算设备400的一个或多个输出设备408可以生成输出。输出的实例为触觉、音频和视频输出。在一个实例中，计算设备400的输出设备408包括存在敏感显示器、声卡、视频图形适配器卡、扬声器、阴极射线管（CRT）显示器、液晶显示器（LCD），或者用于向人类或机器生成输出的任何其它类型的设备。

计算设备400的一个或多个通信单元406可以通过一个或多个网络与有线或无线外部设备通信，方法是在一个或多个网络上发送和/或接收网络信号。例如，计算设备400可以使用通信单元406在无线电网络（例如蜂窝无线电网络）上发送和/或接收无线电信号。同样，通信单元406可以在卫星网络（例如GPS网络）上发送和/或接收卫星信号。通信单元406的实例包括网络接口卡（例如，以太网卡）、光收发器、射频收发器、GPS接收器，或者可以发送和/或接收信息的任何其它类型的设备。通信单元406的其它实例可以包括移动设备中的GPS、3G、4G和Wi-以及通用串行总线（USB）控制器。

计算设备400中的一个或多个存储设备414可以存储所需的信息，以便在计算设备400的操作期间使用。在某些实例中，存储设备414的主要用途是作为短期和非长期计算机可读存储介质。可以配置计算设备400上的存储设备414以便作为易失性存储器短期存储信息，因此如果断电，则不保留存储的内容。易失性存储器的实例包括随机存取存储器（RAM）、动态随机存取存储器（DRAM）、静态随机存取存储器（SRAM），以及所属技术领域中已知的其它形式的易失性存储器。还可以配置存储设备414以便作为非易失性存储空间长期存储信息，并且在通电/断电循环之后保留信息。非易失性存储器的实例包括硬磁盘、光盘、软盘、闪存，或者电可编程存储器（EPROM）或电可擦式可编程（EEPROM）存储器的形式。存储设备414可以存储程序指令和/或与服务提供者418、语义模型420、语义结构422、文档主题424、模型处理模块428、业务规则、问题报告432和/或文档生成模块434关联的数据。

一个或多个处理器402可以在计算设备400中实现功能和/或执行指令。例如，计算设备400上的处理器402可以读取和执行由存储设备414存储的指令，这些指令执行一个或多个服务提供者418和模型处理模块428的功能。由处理器402执行的这些指令可以导致计算设备400在程序执行期间将信息存储在存储设备414中。处理器402可以执行一个或多个服务提供者418、模型处理模块428和文档生成模块434以便执行各种操作。

类似于图1中所示的服务提供者110，一个或多个服务提供者418可以包括提供一个或多个软件功能和服务的一个或多个应用，例如一个或多个Web应用。一个或多个服务提供者418可以包括一个或多个接口（例如Web接口），以便访问由一个或多个服务提供者418提供的软件功能和服务。例如，一个或多个服务提供者418的接口可以提供包括一组方法的API，外部客户端（未示出）可以通过通信单元406调用这些方法，以便访问由一个或多个服务提供者418提供的软件功能。

语义模型420可以在语义上定义一个或多个服务提供者418的接口。语义模型420可以是语义结构树，包括定义Web接口的至少一部分以便访问服务提供者418的语义结构422。语义结构422可以包括记录语义结构422的文档主题424。文档主题424还可以指示语义结构422如何与语义模型420中的其它语义结构相关。

模型处理模块428（类似于图2中所示的模型处理模块218和图3中所示的模型处理模块306）可以处理应用模型420，以便生成包括一个或多个服务提供者418的接口的机器可读描述的服务描述，例如图1中所示的服务描述108和图2中所示的服务描述216。模型处理模块428可以处理语义模型420以便生成服务描述。

模型处理模块428还可以通过应用业务规则430（类似于图3中所示的业务规则310），验证文档主题（包括文档主题424），这些业务规则使用语义模型420交叉引用文档主题和/或相关文档主题，并且模型处理模块428可以通过在问题报告432（类似于图3中所示的问题报告308）中插入表项，报告在文档主题中检测到的任何问题。

文档生成模块434可以处理由模型处理模块428生成的文档，以便生成记录一个或多个服务提供者418的接口的文档文件以供外部使用。文档生成模块434可以包括一个或多个模块，这些模块基于文档主题的元数据，判定是否在生成的文档文件中包括文档主题。例如，文档主题的元数据中的提供者值可以影响文档生成模块434基于文档主题创建文档文件。如果元数据中的提供者值是开发人员，则它可以指示文档主题的内容由语义模型420的开发人员提供以便由语义模型420的其它内部开发人员使用。因此，文档主题的内容可能没有足够质量以便在文档文件中发布。因此，此类文档主题可以具有由编写人员提供的相关主题。当文档生成模块434处理应用模型中的文档以便生成文档文件时，文档生成模块434可能不会基于文档主题生成文档文件中的任何内容。相反，可以使用由编写人员提供的相关主题替换文档主题，以便生成文档文件的内容。

此外，元数据中的使用者值可以影响基于文档主题创建文档文件，以便可以删除未旨在用于文档文件受众的主题。例如，如果元数据中的使用者值是开发人员（例如，内部开发人员），则包括元数据的文档主题可以不包括在文档文件中，因为用于内部开发人员的文档可能不会在外部发布。

图5是示出根据本公开的某些方面的用于验证文档主题的一个实例过程的流程图。所述过程可以包括：由至少一个处理器确定记录至少一个软件功能的多个文档主题中的一个或多个文档主题中的一个或多个问题，所述确定至少基于将一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题，所述应用包括以下操作中的一个或多个：将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据，以便针对所述至少一个软件功能使用语义模型交叉引用所述多个文档主题中的所述一个或多个文档主题的所述元数据，将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的内容，以便针对所述至少一个软件功能使用所述语义模型交叉引用所述多个文档主题中的所述一个或多个文档主题的所述内容，以及将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据和一个或多个相关文档主题的元数据，以便测试所述多个文档主题中的所述一个或多个文档主题的所述元数据与所述一个或多个相关文档主题的所述元数据之间的一致性（502）。所述过程还可以包括：响应于确定所述一个或多个问题，由所述至少一个处理器将一个或多个表项插入问题报告，其中所述一个或多个表项包括有关所述一个或多个问题的信息（504）。

在某些实例中，将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据可以包括：响应于针对所述至少一个软件功能确定所述语义模型中与所述多个文档主题中的所述一个或多个文档主题关联的语义结构过时，至少部分地基于所述多个文档主题中的所述一个或多个文档主题的所述元数据，判定所述多个文档主题中的所述一个或多个文档主题是否是过时的原始主题。在某些实例中，将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据可以包括：响应于至少部分地基于所述多个文档主题中的所述一个或多个文档主题的所述元数据而确定所述多个文档主题中的所述一个或多个文档主题是过时的原始主题，针对所述至少一个软件功能判定所述语义模型中与所述多个文档主题中的所述一个或多个文档主题关联的语义结构是否过时。

在某些实例中，将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据可以包括：响应于针对所述至少一个软件功能确定所述语义模型中与所述多个文档主题中的所述一个或多个文档主题关联的语义结构被弃用，判定所述多个文档主题中的所述一个或多个文档主题是否是弃用的原始主题。在某些实例中，将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据可以包括：响应于至少部分地基于所述多个文档主题中的所述一个或多个文档主题的所述元数据而确定所述多个文档主题中的所述一个或多个文档主题是弃用的原始主题，针对所述至少一个软件功能判定所述语义模型中与所述多个文档主题中的所述一个或多个文档主题关联的语义结构是否被弃用。

在某些实例中，将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据和一个或多个相关文档主题的元数据可以包括：响应于确定所述多个文档主题中的所述一个或多个文档主题由模型开发人员提供，判定所述一个或多个相关文档主题是否由信息开发人员提供。在某些实例中，将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的内容可以包括：判定所述多个文档主题中的所述一个或多个文档主题的所述内容是否包括一个或多个无效引用元素。

在某些实例中，所述多个文档主题中的所述一个或多个文档主题的所述元数据包括以下项中的一个或多个：主题类型、主题ID、主题提供者、主题使用者或者上次更改日期。在某些实例中，插入所述问题报告的所述表项包括以下项中的一个或多个：主题类型、主题始祖、主题标题、对相关工作单的引用、主题提供者、主题使用者以及最可能解决所述一个或多个问题的团队。在某些实例中，所述至少一个软件功能包括用于Web服务的接口。

所属技术领域的技术人员知道，本发明的各个方面可以实现为系统、方法或计算机程序产品。因此，本发明的各个方面可以具体实现为以下形式，即：完全的硬件实施方式、完全的软件实施方式（包括固件、驻留软件、微代码等），或硬件和软件方面结合的实施方式，这里可以统称为“电路”、“模块”或“系统”。此外，本发明的各个方面还可以实现为在一个或多个计算机可读介质中的计算机程序产品的形式，该计算机可读介质中包含计算机可读的程序代码。

可以采用一个或多个计算机可读介质的任意组合。计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质。计算机可读存储介质例如可以是—但不限于—电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者上述的任意合适的组合。计算机可读存储介质的更具体的例子（非穷举的列表）包括：具有一个或多个导线的电连接、便携式计算机盘、硬盘、随机存取存储器（RAM）、只读存储器（ROM）、可擦式可编程只读存储器（EPROM或闪存）、光纤、便携式紧凑盘只读存储器（CD-ROM）、光存储器件、磁存储器件、或者上述的任意合适的组合。在本文件中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。

计算机可读的信号介质可以包括例如在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括—但不限于—电磁信号、光信号或上述的任意合适的组合。计算机可读的信号介质可以是计算机可读存储介质以外的任何计算机可读介质，该计算机可读介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。

计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括—但不限于—无线、有线、光缆、RF等等，或者上述的任意合适的组合。

可以以一种或多种程序设计语言的任意组合来编写用于执行本发明的各个方面的操作的计算机程序代码，所述程序设计语言包括面向对象的程序设计语言—诸如Java、Smalltalk、C++等，还包括常规的过程式程序设计语言—诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中，远程计算机可以通过任意种类的网络—包括局域网（LAN）或广域网（WAN）—连接到用户计算机，或者，可以连接到外部计算机（例如利用因特网服务提供商来通过因特网连接）。

将参照根据本发明实施例的方法、装置（系统）和计算机程序产品的流程图和/或框图描述本发明的各个方面。应当理解，流程图和/或框图的每个方框以及流程图和/或框图中各方框的组合，都可以由计算机程序指令实现。这些计算机程序指令可以提供给通用计算机、专用计算机或其它可编程数据处理装置的处理器，从而生产出一种机器，使得这些指令在通过计算机或其它可编程数据处理装置的处理器执行时，产生了实现流程图和/或框图中的一个或多个方框中规定的功能/动作的装置。

也可以把这些计算机程序指令存储在计算机可读介质中，这些指令使得计算机、其它可编程数据处理装置、或其它设备以特定方式工作，从而，存储在计算机可读介质中的指令就产生出包括实现流程图和/或框图中的一个或多个方框中规定的功能/动作的指令的制造品（article ofmanufacture）。

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

附图中的流程图和框图显示了根据本发明的不同实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段或代码的一部分，所述模块、程序段或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能可以以不同于附图中所标注的顺序发生。例如，两个连续的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合，可以用执行规定的功能或动作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

已描述了本公开的各种实例。这些和其它实例都在以下权利要求的范围内。

Claims

1.一种用于针对至少一个软件功能验证文档的方法，包括：

由至少一个处理器确定记录至少一个软件功能的多个文档主题中的一个或多个文档主题中的一个或多个问题，所述确定至少基于将一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题，所述应用包括以下操作中的一个或多个：

将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据，以便针对所述至少一个软件功能使用语义模型交叉引用所述多个文档主题中的所述一个或多个文档主题的所述元数据，

将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的内容，以便针对所述至少一个软件功能使用所述语义模型交叉引用所述多个文档主题中的所述一个或多个文档主题的所述内容，以及

将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据和一个或多个相关文档主题的元数据，以便测试所述多个文档主题中的所述一个或多个文档主题的所述元数据与所述一个或多个相关文档主题的所述元数据之间的一致性；以及

响应于确定所述一个或多个问题，由所述至少一个处理器将一个或多个表项插入问题报告，其中所述一个或多个表项包括有关所述一个或多个问题的信息。

2.根据权利要求1的方法，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据进一步包括：

响应于针对所述至少一个软件功能确定所述语义模型中与所述多个文档主题中的所述一个或多个文档主题关联的语义结构过时，至少部分地基于所述多个文档主题中的所述一个或多个文档主题的所述元数据，判定所述多个文档主题中的所述一个或多个文档主题是否是过时的原始主题。

3.根据权利要求1的方法，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据进一步包括：

响应于至少部分地基于所述多个文档主题中的所述一个或多个文档主题的所述元数据而确定所述多个文档主题中的所述一个或多个文档主题是过时的原始主题，针对所述至少一个软件功能判定所述语义模型中与所述多个文档主题中的所述一个或多个文档主题关联的语义结构是否过时。

4.根据权利要求1的方法，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据进一步包括：

响应于针对所述至少一个软件功能确定所述语义模型中与所述多个文档主题中的所述一个或多个文档主题关联的语义结构被弃用，判定所述多个文档主题中的所述一个或多个文档主题是否是弃用的原始主题。

5.根据权利要求1的方法，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据进一步包括：

响应于至少部分地基于所述多个文档主题中的所述一个或多个文档主题的所述元数据而确定所述多个文档主题中的所述一个或多个文档主题是弃用的原始主题，针对所述至少一个软件功能判定所述语义模型中与所述多个文档主题中的所述一个或多个文档主题关联的语义结构是否被弃用。

6.根据权利要求1的方法，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据和一个或多个相关文档主题的元数据进一步包括：

响应于确定所述多个文档主题中的所述一个或多个文档主题由模型开发人员提供，判定所述一个或多个相关文档主题是否由信息开发人员提供。

7.根据权利要求1的方法，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的内容进一步包括：

判定所述多个文档主题中的所述一个或多个文档主题的所述内容是否包括一个或多个无效引用元素。

8.根据权利要求1的方法，其中所述多个文档主题中的所述一个或多个文档主题的所述元数据包括以下项中的一个或多个：主题类型、主题ID、主题提供者、主题使用者或者上次更改日期。

9.根据权利要求1的方法，其中插入所述问题报告的所述一个或多个表项包括以下项中的一个或多个：主题类型、主题始祖、主题标题、对相关工作单的引用、主题提供者、主题使用者以及最可能解决所述一个或多个问题的团队。

10.根据权利要求1的方法，其中所述至少一个软件功能包括用于Web服务的接口。

11.一种系统，包括：

至少一个处理器；

存储器；

模型处理模块，其存储在所述存储器中并可由所述至少一个处理器操作以便：

响应于确定所述一个或多个问题，将一个或多个表项插入问题报告，其中所述一个或多个表项包括有关所述一个或多个问题的信息。

12.根据权利要求11的系统，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据进一步包括：

13.根据权利要求11的系统，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据进一步包括：

14.根据权利要求11的系统，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据进一步包括：

15.根据权利要求11的系统，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据进一步包括：

16.根据权利要求11的系统，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的元数据和一个或多个相关文档主题的元数据进一步包括：

17.根据权利要求11的系统，其中将所述一个或多个业务规则应用于所述多个文档主题中的所述一个或多个文档主题的内容进一步包括：

18.根据权利要求11的系统，其中所述多个文档主题中的所述一个或多个文档主题的所述元数据包括以下项中的一个或多个：主题类型、主题ID、主题提供者、主题使用者或者上次更改日期。

19.根据权利要求11的系统，其中插入所述问题报告的所述一个或多个表项包括以下项中的一个或多个：主题类型、主题始祖、主题标题、对相关工作单的引用、主题提供者、主题使用者以及最可能解决所述一个或多个问题的团队。

20.根据权利要求11的系统，其中所述至少一个软件功能包括用于Web服务的接口。

21.一种用于针对至少一个软件功能验证文档的系统，所述系统包括用于实现权利要求1-10中的任何方法的任何步骤的装置。