Documentation Types

Use

To allow customers to create both their own documentation and to enhance SAP originals, the following document types are distinguished:

• Original

  Documents created by SAP have the type "original". If you write documentation for development objects of your own, these are also considered as originals.

• Enhancement

  If you want to document objects for which SAP originals already exist, or which were flagged as 'not to be documented', you can create documents of type "enhancement". These documents overwrite the originals in the help display, without technically deleting them.

  You have the option of integrating the original SAP documentation into your modified documentation so that you can copy any changes to your documentation when upgrades are carried out. When SAP objects were delivered undocumented and not flagged as "not to be documented", the customer documentation has document type "Original".

  Note that yYour documentation can be overwritten after a Release change if SAP documentation is subsequently delivered.

  • You can create enhancements in three ways:

  • Create a new, independent text.

  • Copy and enhance the original text. INCLUDE the originals and enhance.

A further distinction is made between the following types of documentation:

• End User Documentation

  These are help texts that are required for working with applications:

  • Input/output fields

  • Messages

  • ABAP Syntax Documentation

  • Release notes

  • etc.

• Technical Documentation

  These are help texts that describe ABAP Development Workbench objects required for developing programs:

  • Domains

  • Function Modules

  • Corrections

  • etc.

The following four types of documentation exist:

• Original - end user

• Original - developer

• Enhancement - end user

• Enhancement - developer