Extracting Functional Content From Online Documentation

Resolve Bottlenecks,
Find Innovative SolutionsGenerate Solutions

Solution Overview

Problem

System administrators and developers face difficulties in efficiently reading, interpreting, and applying reference code from online software documentation due to its vastness and incompatibility with newer or differently configured software versions, leading to errors and inefficiencies.

Innovation Solution

A computer-implemented method that extracts functional content from online documentation based on decision criteria, creating a functional content artifact which can be presented, transferred, and modified for an operational environment, facilitating easier integration and application of code.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Loss of information

If complete online documentation is provided to users, then comprehensive information is available, but users face difficulties in efficiently reading, interpreting, and applying the code

Engineering Contradiction:

Improvecomprehensive information availabilityVSAvoidefficiency of reading and applying code

Core Design Contradiction:

Loss of informationVSEase of operation

Solution Approach 1:

The patent segments the complete online documentation into distinct functional content artifacts and information content. The functional content is extracted into separate executable artifacts that can be independently processed and applied, while the information content remains as reference material. This segmentation allows users to access only the necessary executable code portions without wading through extensive documentation text.

Inventive Principle:

Principle #1Segmentation

Solution Approach 2:

The patent extracts functional content from the complete online documentation into separate functional content artifacts. This extraction process isolates the executable code portions from the informational text, allowing users to directly access and apply the functional content without having to read and interpret the entire documentation set.

Inventive Principle:

Principle #2Taking out (Extraction)

2Loss of information

If complete online documentation is provided to users, then all reference code is available, but users face errors and inefficiencies due to incompatibility with newer or differently configured software versions

Engineering Contradiction:

Improveavailability of reference codeVSAvoidcompatibility with software versions

Core Design Contradiction:

Loss of informationVSReliability

Solution Approach 1:

The patent enables dynamic adaptation of functional content artifacts to different software versions and configurations. The system can modify the extracted functional content based on the target operational environment's characteristics, ensuring compatibility with newer or differently configured software versions while maintaining the original comprehensive reference code availability.

Inventive Principle:

Principle #15Dynamics

Solution Approach 2:

The patent applies parameter changes to adapt the functional content artifacts to different software environments. By modifying parameters such as configuration settings, version compatibility flags, and environmental dependencies, the system ensures that the extracted functional content remains reliable across various software versions and configurations.

Inventive Principle:

Principle #35Parameter changes

3Loss of information

If users manually read and interpret code in online documentation, then comprehensive understanding is possible, but the process is time-consuming and error-prone

Engineering Contradiction:

Improvecomprehensive understandingVSAvoidtime to read and interpret code

Core Design Contradiction:

Loss of informationVSLoss of time

Solution Approach 1:

The patent creates copies of the functional content from the online documentation in a structured, executable artifact format. These functional content artifacts preserve the complete functional information while presenting it in a format that requires minimal interpretation, significantly reducing the time and effort needed to understand and apply the code.

Inventive Principle:

Principle #26Copying

Solution Approach 2:

The patent introduces functional content artifacts as an intermediary between the complete online documentation and the user. This intermediary format automatically structures and presents the functional content in a more accessible manner, reducing the need for manual reading and interpretation while preserving comprehensive understanding.

Inventive Principle:

Principle #24Intermediary (Mediator)

Data Source

PatentUS10740538B2Extraction and transformation of executable online documentation

Publication Date: 2020.08.11 INTERNATIONAL BUSINESS MACHINE CORPORATION

AI summary

A computer-implemented method includes receiving a content artifact. The content artifact includes information content and functional content. Extracting the functional content includes creating a functional content artifact. The computer-implemented method further includes extracting the functional content into a functional content artifact based on one or more decision criteria. The computer-implemented method further includes presenting the functional content artifact to a functional content artifact application. Optionally, the computer-implemented method further includes transferring the functional content artifact to an operational environment. Optionally, the computer-implemented method further includes modifying the functional content artifact into a modified functional content artifact. Optionally, the computer-implemented method further includes making available the modified functional content artifact available to an operational environment. A corresponding computer program product and computer system are also disclosed.