Writing BAPI Documentation (SAP Library - BAPI Programming Guide Reference (CA-BFA))

Writing BAPI Documentation

Writing Documentation on BAPIs

Writing BAPI documentation involves the following processes:

Determining the BAPIs to be documented.

Writing BAPI documentation and parameter documentation.

Determining whether data element documentation for each field of a BAPI parameter exists, and, if necessary, writing it.

You must also specify an external default field name in English for the data element documentation.

Determining whether documentation for the business object and its key fields exists, and, if necessary, writing it.

Writing Release Notes for the BAPIs.

Developers may make changes to BAPIs between releases. Discuss this with your developers so that existing BAPI documentation is kept up-to-date.

Determining the BAPIs to be Documented

The following sources of information are available to find out which BAPIs need to be documented:

Ask the developer.

The work list in transaction SE61.

BAPI Explorer: Navigate through the application hierarchy to the BAPIs in your application area.

Business Object Repository (to display objects: transaction SWO3, to change objects: transaction SWO1): Use the application hierarchy to display BAPIs. BAPIs are identified by a green circle next to the method name.

Object Navigator (transaction SE80): You can use the appropriate function group or development class to select BAPIs.