Start of Content Area

Object documentation General Information Classes  Locate the document in its SAP Library structure

Definition

Method of classifying SAP documentation by content, to make specific types of documentation easier to find.

Structure

Component documentation Component

Keyblock

Answers the following questions:

Title

What is this component called?

Purpose

What is it? What does it do?

Implementation Considerations

What business or technical prerequisites do I consider when deciding whether to implement these components?

Integration

How is the component related to other components or functions?

Features

What capabilities does the component describe?

Example: "Shipping"

 

Function documentation Function

Keyblock

Answers the following questions:

Title

What is the function called?

Use

What does it do (in general)?

Integration

How is this function related to other functions?

Prerequisites

What prerequisites must be met before I can use this function?

Features

What does the function do (in detail)?

Activities

What do I need to do? What does the system do?

Example: "How Picking Lists are Handled in the SAP System"

 

Object documentation Object

Keyblock

Answers the following questions:

Title

What is the object called?

Definition

What is the object?

Use

How can I use this object (in general)?

Structure

What are the parts of the object?

Integration

How is this object related to other objects?

Example: "Collective Picking List"

 

Process documentation Process

Keyblock

Answers the following questions:

Title

What is the process called?

Purpose

How can I use the process?

Prerequisites

What prerequisites need to be met before the process can start?

Process Flow

When does the process start? How does the process work?

Result

What is the overall result of the process?

Example: "Picking"

 

Procedure documentation Procedure

Keyblock

Answers the following questions:

Title

What is the task?

Use

What are the purpose and result of this procedure? Why do I perform this procedure (context)?

Prerequisites

What prerequisites must be met before I can start this procedure?

Procedure

What actions do I perform?

Result

What is the overall result of completing the procedure?

Example: "Creating a Collective Picking List"

 

Glossary

Keyblock

Answers the Following Questions:

Title

[Term]

Component ID

Which components does this definition refer to?

Definition

What does the term mean?

Example

How can the defined term be used in an example?

 

Release Note

Keyblock

Answers the Following Questions:

Title

What is new in this release? What was changed or deleted?

Use

What does the new development or changed function do? Why do I need it? How is the new function integrated in the system, and how does it work with related functions?

Effects on Existing Data

How does the new development or changed function affect existing system data?

Effects on Data Transfer

How does the new development or changed function affect data transfer? What changes do I need to make to my own programs to enable the data transfer?

Effects on System Administration

How does the new development or changed function affect the system from a system administration perspective?

Effects on Customizing

How does the new development or changed function affect the specific components in Customizing? Which activities must be carried out in the Implementation Guide as a result?

 

Further Information Classes

Information Class

Icon

Meaning

Example

This graphic is explained in the accompanying text

Concrete example of an object, process, or similar concept

Background

Background documentation

Background information on a specific subject

Syntax

Syntax documentation

Technical information about, for example, the syntax of a programming language

 

 

End of Content Area