Show TOC Anfang des Inhaltsbereichs

Objektdokumentation Allgemeine Informationsklassen  Dokument im Navigationsbaum lokalisieren

Definition

Informationsklassen dienen zur inhaltlichen Einteilung der SAP-Dokumentation, um das Auffinden bestimmter Dokumentationsarten zu erleichtern.

Struktur

Komponentendokumentation Komponente

Textabschnitt

Beantwortet folgende Fragen

Titel

Wie heißt die Komponente?

Einsatzmöglichkeiten

Worum handelt es sich? Was leistet die Komponente?

Einführungshinweise

Unter welchen (betriebswirtschaftlichen oder technischen) Voraussetzungen entscheide ich mich, diese Komponente zu implementieren und einzusetzen?

Integration

Welche Beziehungen bestehen zwischen dieser Komponente und anderen Komponenten oder Funktionen?

Funktionsumfang

Welche Möglichkeiten bietet diese Komponente?

Beispiel: "Versand"

 

Funktionsdokumentation Funktion

Textabschnitt

Beantwortet folgende Fragen

Titel

Wie heißt die Funktion?

Verwendung

Was leistet diese Funktion (allgemein)?

Integration

Welche Beziehungen bestehen zwischen dieser und anderen Funktionen?

Voraussetzungen

Welche Voraussetzungen müssen erfüllt sein, bevor ich diese Funktion einsetzen kann?

Funktionsumfang

Was leistet diese Funktion (Details, Besonderheiten)?

Aktivitäten

Was muss ich tun? Was tut das System?

Beispiel: "Lieferungen aus Projekten"

 

Objektdokumentation Objekt

Textabschnitt

Beantwortet folgende Fragen

Titel

Wie heißt das Objekt?

Definition

Wie ist das Objekt definiert?

Verwendung

Wie kann ich dieses Objekt verwenden (allgemein)?

Struktur

Aus welchen Teilen besteht das Objekt?

Integration

Welche Beziehungen bestehen zwischen diesem und anderen Objekten?

Beispiel: "Einkaufsbeleg"

 

Prozessdokumentation Prozess

Textabschnitt

Beantwortet folgende Fragen

Titel

Wie heißt der Prozess?

Einsatzmöglichkeiten

Wofür kann ich diesen Prozess einsetzen?

Voraussetzungen

Welche Voraussetzungen müssen erfüllt sein, bevor der Prozess beginnen kann?

Ablauf

Wann beginnt der Prozess? Wie läuft der Prozess ab?

Ergebnis

Was ist das Ergebnis des Prozesses?

Beispiel: "Routenermittlung"

 

Vorgehensweisen Vorgehensweise

Textabschnitt

Beantwortet folgende Fragen

Titel

Um welche Vorgehensweise handelt es sich?

Verwendung

Was sind Zweck und Ergebnis dieser Vorgehensweise? Warum führe ich diese Vorgehensweise aus (Kontext)?

Voraussetzungen

Welche Voraussetzungen müssen erfüllt sein, bevor ich die Vorgehensweise ausführen kann?

Vorgehensweise

Welche Schritte muss ich ausführen?

Ergebnis

Was ist das Gesamtergebnis der Vorgehensweise?

Beispiel: "Kommissionierdaten rückmelden"

 

Glossar

Textabschnitt

Beantwortet folgende Fragen:

Titel

[Begriff]

Komponentenkürzel

Auf welche Komponente bezieht sich die Definition?

Definition

Was bedeutet der Begriff?

Beispiel

Wie kann man den definierten Begriff beispielsweise verwenden?

 

Release-Information

Textabschnitt

Beantwortet folgende Fragen:

Titel

Was ist in diesem Release neu, geändert oder gelöscht?

Verwendung

Was leistet die Neuerung oder Änderung? Wofür brauche ich sie? Wie ist die neue Funktion in das System integriert und wie arbeitet sie mit verbundenen Funktionen zusammen?

Auswirkungen auf den Datenbestand

Wie wirkt sich die Neuerung oder Änderung auf bestehende Systemdaten aus?

Auswirkungen auf die Datenübernahme

Wie wirkt sich die Neuerung oder Änderung auf die Datenübernahme aus? Welche Anpassungen muss ich in eigenen Programmen für die Datenübernahme vornehmen?

Auswirkungen auf die Systemverwaltung

Welche Auswirkungen hat die Neuerung oder Änderung aus der Sicht der Systemverwaltung?

Auswirkungen auf das Customizing

Wie wirkt sich die Neuerung oder Änderung auf die spezifischen Komponenten im Customizing aus? Welche Aktivitäten müssen als Folge im Einführungsleitfaden ausgeführt werden?

 

Weitere Informationsklassen:

Informationsklasse

Symbol

Bedeutung

Beispiel

Diese Grafik wird im zugehörigen Text erklärt

konkretes Beispiel für ein Objekt oder einen Prozess oder ähnliches

Hintergrund

Hintergrunddokumentation

Hintergrundinformationen zu einem Thema

Syntax

Syntaxdokumentation

Beispielsweise technische Informationen über die Syntax einer Programmiersprache

 

Ende des Inhaltsbereichs