Struktur und Inhalt der Dokumentation (SAP-Bibliothek - Referenz zum BAPI-Programmierleitfaden (CA-BFA))

Struktur und Inhalt der Dokumentation

Key-Blocks

Die folgende Tabelle listet die Key-Blocks sowie die Art der Informationen in jedem Key-Block auf. Behalten Sie die Fragen zu jedem Key-Block im Auge, wenn Sie Business-Objekt-Dokumentation schreiben. Jedes Element (Satz, Absatz, Grafik, Beispiel) muß zur Beantwortung dieser Fragen beitragen.

Key-Block	Beantwortet folgende Fragen:
Definition	Wie ist das Business-Objekt definiert?	obligatorisch
Verwendung	Wie kann ich dieses Business-Objekt verwenden ? (allgemein) Wo kann ich es verwenden ? Welche Einschränkungen gelten für die Verwendung des Business Objektes ?	optional
Struktur	Aus welchen Teilen besteht das Business-Objekt ? Welchen Zweck erfüllt jedes Einzelteil?	optional
Integration	Welche Beziehungen bestehen zwischen diesem und anderen Business-Objekten?	optional
Beispiel	Wie sieht der Einsatz in der Praxis aus ?	optional

Definition

Geben Sie eine kurze Definition des Business Objektes.

Wenden Sie die Richtlinien für das Glossar auf diesen Keyblock an.

Verwendung

Beschreiben Sie, wie das Objekt in Ihrer Anwendung verwendet wird.

Wiederholen Sie nicht den Inhalt des Keyblocks Definition.

Strukturieren Sie die Informationen -wo angebracht- durch Unterüberschriften und Listen.

Nennen Sie alle Einschränkungen der Objektverwendung (z.B. die Tatsache, daß der Materialstammsatz nur für ein Werk gültig ist, nicht für mehrere gleichzeitig).

Struktur

Beschreiben Sie die innere Struktur und den Aufbau des Business-Objektes.

Integration

Listen Sie die anderen Business-Objekte auf, die mit diesem Business Objekt zusammenhängen.

Beschreiben Sie Objektabhängigkeiten und -beziehungen.

Beispiel

Geben Sie ein praktisches Beispiel zu dem Business-Objekt an.

Allgemeine Standards und Richtlinien

Ja

Verwenden Sie Listen und Unterüberschriften, um überlange Abschnitte aufzulockern.

Erläutern Sie nur die wichtigsten Konzepte.

Nein

Verwenden Sie keine numerierten Listen.

Beschreiben Sie keine Folge von Ereignissen (Prozeß).

Beschreiben Sie nicht die Ausführung einer Funktion (Vorgehensweise).