An error message transformation framework; a process and utilities for following an iterative quality improvement message development, documentation and delivery process
Publication Date: 2010-Apr-06
The IP.com Prior Art Database
Disclosed is an error message process for developing error messages, providing content quality and completeness, and transforming the content to user documentation that is delivered as part of a product offering.
An error message transformation framework ; a process and utilities for following an iterative quality improvement message development , documentation and delivery process
While there are existing solutions to aspects of an error message strategy, there is currently no comprehensive solution to the entire error message process from developing error messages, ensuring content quality and completeness, and transforming the content to user documentation that is delivered as part of a product offering.
For example, while development teams create error messages and some error messages are included in product documentation, and some automation is used by some development or documentation groups, there are currently no solutions to automating the transformation of error message source files to product documentation and including online review capabilities to that
product documentation that can then be used to enhance the original error message source files.
There are existing transforms for generating user assistance from xml or properties error message source files and there are existing online review utilities but there is no process for a unified error message strategy that includes automated building and delivery of the user assistance.
The framework described in this article, however, leverages these existing components and
provides the full end-to-end solution.
One of the serviceability imperatives is for all products to provide better error messages that are helpful for customers to understand how to correct their errors. Part of providing better error messages is to also have error message user assistance that can provide better quality and completeness of information for an error message.
The error message framework provides a solution to having an error message strategy for developing software products and including unique error IDs with meaningful error message explanations and resolution text. The framework provides a comprehensive solution for these components of an error message framework:
- Delivering that error message information in a form of user assistance (such as product documentation or as messages in the user interface).
- Making error message information searchable and "findable" based on the unique ID.
- Enabling viewers of the error message content to provide feedback on it so the information can be enhanced in later iterations.
An example of user assistance is a product information center. Each error message is included as a separate help topic that can be searched on and found by a unique ID. From each help topic, (internal or external) customers can click Feedback to provide input to the error messages. This input can help drive change for improving the content quality and completeness in future iterations (or later releases) of the error message content.
This development, transformation, delivery, and feedback process provides the capabilities for ongoing iterative improvements to error message content for pro...