Allgemeine Regeln zum Inhalt der Nachricht:
- Großschreibung am Anfang eines Feldes
- Abkürzungen vermeiden: FBU = Finanzbuchhaltung, PGM = Programm
- Genormte Abkürzungen dürfen verwendet werden: bzgl. / bspw. / z. B. / etc. / usw. / u. A. / ...
- Programm-Kurzbefehle ohne endendes "R" schreiben, damit automatisch der Programmname gezogen wird
- Variable werden mit " " gekennzeichnet
- Feldnamen, Parameter, etc. werden mit " " gekennzeichnet
Nachrichtentext:
- Knappe Erläuterung in maximal einer Zeile.
- Kein Punkt am Ende der Zeile.
Ursache:
- Es ist eine eindeutige, für den Anwender verständliche Ursache anzugeben.
- Hierbei ist eine klare Unterscheidung zwischen Ursache und Maßnahme zu treffen. Als Ursache wird der Ursprung der Fehlernachricht definiert.
- Die Beschreibung endet mit einem Punkt.
Maßnahme:
- Auch hier muss klar die Maßnahme von der Ursache unterschieden werden. Eine Maßnahme ist eine Aktion, die ein Anwender aktiv durchführen muss, um dem Fehler / der Meldung entgegenzuwirken.
- Gibt es keine Maßnahme, bleibt das Feld leer und wird nicht mit "Keine." gefüllt.
- Die Beschreibung endet mit einem Punkt.