Dokumentation und Dokumentationsstatus 

Verwendung

Die zu einem Datenelement erfasste Dokumentation wird bei Betätigung der F1-Hilfe auf jedem Dynprofeld angezeigt, welches auf dieses Datenelement verweist. Ist keine Dokumentation zum Datenelement vorhanden, so erscheint bei der F1-Hilfe nur der Kurztext des Datenelements. Datenelemente, die auf Eingabemasken verwendet werden, sollten daher dokumentiert werden. In der folgenden Abbildung werden die Beziehungen zwischen einer Eingabemaske, einem Tabellenfeld, einem Datenelement und der Dokumentation zu diesem Datenelement aufgezeigt.

Der Dokumentationsstatus bestimmt, inwieweit für ein Datenelement schon Dokumentation erfasst wurde bzw. ob Gründe vorliegen, die dies unnötig erscheinen lassen. Sie können den Dokumentationsstatus eines Datenelements im Pflegebild des Datenelements über Springen → Dokumentation → Status anzeigen.

Folgende Statusangaben sind möglich:

●      Objekt wird dokumentiert:

Standardeinstellung. Dokumentation ist entweder schon vorhanden oder muss noch erstellt werden.

●      Objekt wird nicht auf Maske verwendet:

Das Objekt wird nicht auf einem Dynpro verwendet. Dokumentation ist nicht vorhanden und soll auch nicht erstellt werden.

●      Objekt wird durch Kurztext dokumentiert:

Der Kurztext erklärt das Objekt schon ausreichend. Dokumentation ist nicht vorhanden und soll auch nicht erstellt werden.

●      Dokumentation wird vorübergehend zurückgestellt:

Diese Angabe ist zum Beispiel sinnvoll, wenn die Verwendung des Datenelements noch nicht vollständig klar ist. Dokumentation ist (noch) nicht vorhanden.