Browse Prior Art Database

Smart image element derived embedded assistance

IP.com Disclosure Number: IPCOM000241928D
Publication Date: 2015-Jun-09
Document File: 5 page(s) / 164K

Publishing Venue

The IP.com Prior Art Database

Abstract

This disclosure is a system/method to: construct or update the code-specific items required to fully and correctly integrate the embedded assistance with the product; keep documentation and product consistent (from an embedded assistance point of view) without need for Information Engineer to get involved in product development and build; select and assemble the embedded assistance topic set based on an established correlation between screen capture context and topic based UI element description.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 33% of the total text.

Page 01 of 5

Smart image element derived embedded assistance

A problem Information Engineers have in developing embedded assistance is the lack of context visibility. UI element strings (button names, etc.) are generally abstracted from the code and placed in a properties file. This properties file typically consists of a tuple set, that is, a unique identifier and a UI element string. It is often very difficult for the Information Engineer to see how the strings (as stored in the properties file) relate to the UI (as displayed within the functioning product). The lack of context visibility compounds the difficulty of writing and appending sensible tooltip information (also known as Hover Help or Mouseover Help) and selecting topics which form the context sensitive help (the set of information topics presented

when the application user presses the F1 button in context).

Another issue is maintainability; any change in the UI, whether that be the

addition, update or removal of a UI element, can be very hard to track for an Information Engineer unless that change is explicitly pointed out by a UI developer.

    With the adoption of a Software as a Service (SaaS) model (and particularly the intuitive/seamless User eXperience expectations that come with SaaS) it is becoming more and more obvious that context sensitive help/embedded assistance is set to be the primary focal point for customer help information. The SaaS model also requires and drives an increased number of product builds and therefore a commensurate increase in the number of embedded assistance deliverables.

    The final part of puzzle is that of integrating the embedded assistance with the product itself. The artefacts required to tie the product and the embedded assistance together are buried in the code, which means the Information Engineer

has to hand roll code-specific items.

    Creating and maintaining embedded assistance is a very time consuming task; can be error prone, due to the dynamic nature of the code and the need for an Information Engineer to contribute to the code base; and requires that the Information Engineer has an in depth and up to the minute knowledge of how specific UI elements relate to the documentation source base, from which the embedded assistance is gathered.

    This disclosure is a system/method to: construct or update the code-specific items required to fully and correctly integrate the embedded assistance with the product; keep documentation and product consistent (from an embedded assistance point of view) without need for Information Engineer to get involved in product

development and build; select and assemble the embedded assistance topic set based on an established correlation between screen capture context and topic based UI element description.

Glossary:

UI elements: These are buttons, fields, check boxes, etc.

Embedded assistance: This is the help information that is embedded in the tooling, otherwise known as on-line help.

Topic: These are the individua...