Documentation Structure and Content (SAP Library - BAPI Programming Guide Reference (CA-BFA))

Documentation Structure and Content

Keyblocks

The following table lists the keyblocks and the type of information they contain. When you write business object documentation, remember the questions for each keyblock. Each element (sentence, paragraph, graphic, example) must contribute to answering these questions.

Keyblock	Answers the Following Questions:
Definition	How is the business object defined?	required
Use	How can I use this business object (in general)? Where can I use it? What constraints apply to using this business object?	optional
Structure	What are the parts of the business object? What is each part used for?	optional
Integration	How is this business object related to other business objects?	optional
Example	Can you give me an example of this object?	optional

Definition

Briefly define the business object.

Follow the content standards for the "Definition" keyblock of glossary entries.

Use

Describe how the object can be used in your component.

Do not repeat the contents of the "Definition" keyblock.

Structure the information, where appropriate, using sub-headings and lists.

List constraints on using the object (for example, only one plant can create or change the material master).

Structure

Describe the internal structure and parts of the business object.

Integration

List the other business objects that interact with this business object.

Describe object dependencies and relationships.

Example

Give a practical example of the business object.

General Standards and Guidelines

Do

Use lists and sub-headings to break up long paragraphs of text.

Explain only the most important concepts.

Don’t

Use numbered lists.

Describe a sequence of events (process).

Describe the execution of a function (step-by-step procedure).