Show TOC

 Documentation and Documentation StatusLocate this document in the navigation structure


Documentation entered for a data element is displayed when you select F1 Help on each screen field that refers to the data element. If there is no documentation for the data element, only the short text of the data element appears for the F1 help. Data elements that are used in input templates must be documented. In the following figure you can see the relations between an input template, a table field, a data element and the documentation on this data element.

The documentation status specifies whether documentation has already been written for a data element and whether documentation is in fact required. To display the documentation status of a data element in the maintenance screen of the data element, choose Goto → Documentation → Status.

The following status entries are possible:

  • Object requires documentation:

    The standard setting. Documentation either already exists or must be written.

  • Object is not used in any screens:

    The object is not used in any screen. Documentation does not exist and is not required.

  • Object explained sufficiently by short text:

    The short text explains the object adequately. Documentation does not exist and is not required.

  • Documentation is postponed temporarily:

    This selection is appropriate, for example, if the use of the data element has not yet been fully clarified. Documentation does not (yet) exist.