Entering content frameObject documentation General Information Classes Locate the document in its SAP Library structure

Definition

Method of classifying SAP documentation by content, in order to make specific types of documentation easier to find. For example, component-level documentation gives you an overview of a component's features, while procedure documentation gives you step-by-step instructions for completing a specific task, such as creating a purchase order.

Structure

Component documentation Component

Keyblock

Answers the questions

Title

What is the component called?

Purpose

What is it? What does it do?

Implementation Considerations

Under what specific considerations (business or technical) would I decide to implement the component?

Integration

How is it related to other components?
Where does it fit in the component hierarchy?
What other components or functions do I need?

Features

What capabilities does the component describe?

Example: "Shipping"

Function documentation Function

Keyblock

Answers the questions

Title

What is the function called?

Use

What does it do (in general)?

Integration

How is it related to other functions?

Prerequisites

What must be in place before I can use the function? What events or system settings?

Features

What does it do (details, special features)?

Activities

What does the user do? What does the system do?

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

Object documentation Object

Keyblock

Answers the questions

Title

What is the object called?

Definition

What does the object mean?

Use

How can I use the object (in general)?

Structure

What are the parts of the object?

Integration

How is the object related to other objects?

Example: "Collective Picking List"

Process documentation Process

Keyblock

Answers the questions

Title

What is the process called?

Purpose

How can I use the process?

Prerequisites

What do I need to know before the process starts?

Process Flow

When does the process begin?
How does the process work?

Result

What is the overall result of the process?

Example: "Picking"

Procedure documentation Procedure

Keyblock

Answers the questions

Title

What is the task?

Use

What is the purpose and effect of the procedure?
Why do I execute the procedure (context)?

Prerequisites

What do I need to know before I start the task?

Procedure

What specific actions do I perform?

Result

What is the overall result of completing the task?

Example: "Creating a Collective Picking List"

 

Background documentation Background

Keyblock

Answers the question

Title

What is the topic background?

This information class has no keyblocks.

 

This graphic is explained in the accompanying text Example

Keyblock

Answers the question

Title

What is this an example of?

This information class has no keyblocks, unless it is an example of a process or a procedure.

 

Syntax documentation Syntax

Keyblock

Answers the question

Title

What is the syntax of this command?

This information class has no keyblocks.

Role documentation Single / Composite Role

Keyblock

Answers the questions

Title

What is the name of the role?

Technical name

What is the technical name of the role?

Tasks

Which business or technical tasks does this role include?

Activities

Which activities does this role include?

Notes on tailoring

Which combinations of roles or activities make sense?

MiniApps

What type of information or functions do the MiniApps provide for this role?

Integration

How does this role relate to other roles?

 

Glossary

Keyblock

Answers the following questions

Title

What is the term?

Component ID

Which component does this definition refer to?

Definition

What does the term mean?

Example

Can you give me an example of how the term is used?

 

Release Note

Keyblock

Answers the following questions

Title

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

Use

What does the new or changed feature do? Why do I need it? How is the new function integrated in the system and how does it relate to other functions?

Effects on Existing Data

How does the new or change feature affect existing system data?

Effects on Data Transfer

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

Effects on System Administration

How does the new or changed feature affect the system from the system administration point of view?

Effects on Customizing

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

 

 

 

Leaving content frame