A method for auto-detecting user interface mismatch with documentation
Publication Date: 2015-Nov-10
The IP.com Prior Art Database
This disclosure describes a method to automatically detect elements in the user interface that are missing from product documentation or user interface descriptions in product documentation that cannot be found in the user interface.
Page 01 of 5
A method for auto
A method for auto-
With faster development circle as a result of agile development methodology, development teams are facing much greater challenges in delivering high-quality software projects with limited resources. Therefore, issues might often occur with user documentation.
It is not uncommon that after a product is released, end customers find mismatches between documentation and the actual user interfaces, which significantly undermines customers' perception of and experience with the product. A method that can automatically detect mismatches between user interfaces and documentation can greatly help minimize such issues and improve customer satisfaction. However, such a method does not seem available currently.
Following this method, testers and information developers can efficiently detect user interface-documentation mismatches and resolve such issues before the product is delivered. The method lays the foundation for any user interface-documentation mismatch auto-detection applications.
This method works by associating program source code with documentation source code. By aligning user interface elements from both sources, this method allows applications to compare keywords (as seen by applications or specified by testers or information developers) on a user interface with keywords in documentation topics that are related to the user interface.
For this method to work, it requires that documentation source is properly tagged with tag attributes that specify the user interface elements to which the information relates. It also requires that an xml file be compiled from the source code, which contains listings of user interface elements in hierarchical order.
The application then can compare the user interface elements in the xml file compiled from the source code with the user interface elements from the documentation source. The application will produce a listing of any mismatched user interface elements, if found. A proper implementation will also allow
writers/testers to mark "ignore" for those user interface elements not intended to be included in documentation. Here is an illustration of this workflow.
--detecting user interface mismatch with documentation
detecting user interface mismatch with documentation
Page 02 of 5
The following is an example.
Suppose a configuration wizard contains the following screen:
Page 03 of 5
The following is the source of the topic that desc...