Help documentation for applications

Attribute(s)

  • System Documentation

    Description

    Help documentation included in the application enhances the acceptance of the application and the usability.

    Motivation

    Functions have been included in the Standard Template to display per form or view a help document in a dialog window.

    Example / Details

    The help documents created with an RT object in the Configuration Outline need
    to have the key set to the AliasName followed by a standard description. The
    naming convention for such help documents must adhere to the following
    convention:
    <AliasName>-Help

    Where: <AliasName> is the Alias of the object (Form or View) which needs to have a user help document configured.

    Example:
    F-StandardForm will have F-StandardForm-Help as the associated Help Document.
    V-Configuration will have V-Configuration-Help as the associated Help Document.