Meldungen, Allgemein

Regeln | Beispiele schlechter und guter Fehlermeldungen | Technische Hinweise

Stellt das System einen Fehler fest, zeigt es je nach Fehlertyp in der Statusleiste oder in einem eigenen Dialogfenster eine Meldung an. Diese Meldung soll dem Benutzer helfen, die Ursachen des Fehlers zu erkennen und anschließend ohne fremde Hilfe korrekt weiterzuarbeiten.

Abbildung 1: Die wichtigsten Regeln für Meldungen

Regeln

Genau und eindeutig

Formulieren Sie Meldungen so genau wie möglich. Meldungen sollten die aufgetretene Situation möglichst eindeutig beschreiben.

Hilfestellung geben

Meldungen sollten dem Benutzer - wenn möglich - eine direkte Hilfestellung zur Fehlerbehebung anbieten. Es ist günstiger, direkt eine Hilfestellung zu geben (s. Beispiele zu "Meldungen, die Aufforderungen an Benutzer enthalten können") als nur eine Fehlerdiagnose anzugeben. Ist dies nicht möglich, kann nur eine Fehlerdiagnose gegeben werden, die so präzise wie möglich in einem positiven Ton formuliert ist. Zusätzlich kann in runden Klammern eine Hilfestellung gesetzt werden, wenn diese bekannt ist.

Formulierung

Formulieren Sie Meldungen in einem freundlichen, positiven Ton und belehren Sie nicht den Benutzer. Vermeiden Sie nichtssagende oder belehrende Worte wie "dürfen", "müssen", "sollen", "gehören", "falsch", "unzulässig", "unvollständig", "nicht erlaubt" oder ähnliches.

Benutzerbezogene Sprache

Verwenden Sie ein Vokabular, das sich an der Aufgabe des Benutzers orientiert und für den Anwender verständlich ist. Vermeiden Sie auch Fehlermeldungen, die sich auf technische Funktionsweisen des Systems beziehen.

Satzstruktur

Bauen Sie Meldungen klar und einfach auf und verwenden Sie nur vollständige Satzteile (das erleichtert auch die Möglichkeit maschinell zu übersetzen). Artikel können weggelassen werden; ein Verb (mindestens: ist, sind) sollte aber immer vorhanden sein. Als Zeit ist nach Möglichkeit die Gegenwartsform zu wählen.

Groß-/Kleinschreibung

Es ist normale Groß-/Kleinschreibung zu verwenden. Verwenden Sie keine Groß- oder Sperrschrift, um Text herauszuheben; Ausnahme: Großschreibung für Reportnamen, Transaktionscodes, Tabellennamen, Dateinamen.

Sprache

Mischen Sie nicht mehrere Sprachen durcheinander, sondern verwenden Sie konsequent deutsche bzw. landesübliche Begriffe.

Zeichensetzung

Schließen Sie die Meldung nicht durch ein Satzzeichen ab - auch nicht durch ein Ausrufungszeichen. Vorschläge zur Fehlerbehebung können in Klammern stehen. Setzen Sie nach Interpunktionszeichen immer ein Leerzeichen und davor kein Leerzeichen.

Sonderzeichen

Verwenden Sie keine Sonderzeichen wie < > oder ähnlich, da sie dem Anwender nicht immer bekannt sind; Wertangaben wie z.B. % können verwendet werden. Meldungen dürfen nicht mit Sternchen (***) eingeleitet bzw. abgeschlossen werden. Setzen Sie Feldnamen, Reportnamen und Tabellennamen grundsätzlich nicht in Hochkommata.

Abkürzungen

Befolgen Sie die Regeln für das Abkürzen (s. Abkürzungen) und verwenden Sie möglichst einheitliche Abkürzungen.

Beispiele schlechter und guter Fehlermeldungen

In den folgenden Themen werden zur Verdeutlichung der oben genannten Prinzipien (kommentarlos) Beispiele von schlechten und neuformulierten Fehlermeldungen aufgeführt.

Meldungen, die spezifischer formuliert werden können

Schlecht: Key & nicht in Tabelle &
Gut: Vertriebsweg & ist nicht vorgesehen (Bitte Eingabe prüfen)
Schlecht: Der Cursor steht nicht auf einer selektierbaren Zeile
Gut: Bitte Cursor zum Selektieren auf eine Zeile der Tabelle stellen
Schlecht: Abruf-Angaben unvollständig
Gut: Bitte Abrufangaben vervollständigen mit Auftragsart, Vertriebsweg
Schlecht: Liste wurde nicht vollständig aufbereitet
Gut: Aufbereitung der Liste bei Systemgrenze (99 Seiten) abgebrochen

Meldungen, die eindeutiger formuliert werden können

Schlecht: Der Eintrag & & & & ist nicht in Tabelle 134
Gut: Die Kombination aus den gewünschten Einträgen ist nicht vorgesehen

Hinweis: Diese Meldung gehörte besser ausführlich in ein Dialogfenster. Oder sie steht im Kurztext wie oben, und im Langtext findet sich dann der Hinweis auf die einzelnen Eingabefelder.

Schlecht: Eingaben unvollständig
Gut: Bitte Eingaben ergänzen
Schlecht: Keine Änderung
Gut: Eingaben wurden nicht übernommen, da bereits vorhanden

Hinweis: Es ist wichtig, die Meldung aus Sicht des Anwenders und nicht aus der Sicht des Systems zu formulieren.

Meldungen, die Aufforderungen an Benutzer enthalten können

Schlecht: Löschkennzeichen falsch, nur 'J', 'S', ' ' erlaubt
Gut: Bitte als Löschkennzeichen 'J', 'S' oder ' ' eingeben
Schlecht: Postleitzahl nicht angegeben bzw. in falscher Länge
Gut: Bitte Postleitzahl in vorgesehener Länge eingeben
Schlecht: Prozentsatz muß kleiner als 100% sein
Gut: Bitte Prozentsatz zwischen 0 und 100 eingeben
Schlecht: Keine Positionen selektiert
Gut: Bitte zuerst Positionen in der Liste markieren
Schlecht: Freigabe-Datum falsch eingegeben
Gut: Bitte Freigabedatum in der Form tt.mm.jjjj eingeben

Technische Hinweise

Meldungen werden wie alle Nachrichtentexte mit Sprachkennzeichen und Message-ID in der Tabelle T100 gepflegt. Relevante Feldinhalte können durch den Platzhalter "&" in den Kurztext der Meldung an den entsprechenden Stellen eingefügt werden. Die aktuellen Feldinhalte werden dann mit WITH an die MESSAGE-Anweisung in der Reihenfolge angehängt, in der sie in den Kurztext eingesetzt werden sollen. Die MESSAGE-ID muß am Anfang des Modulpools in der PROGRAM-Anweisung angegeben werden:

PROGRAM <name> MESSAGE-ID <ID>

Es können mit WITH noch mehr Feldinhalte an die MESSAGE-Anweisung angehängt werden als Platzhalter in den Kurztext eingestreut sind, weil der detailliertere Langtext dies erfordern kann. Alle hinter WITH stehenden Feldinhalte können in beliebiger Reihenfolge durch "&V1&", "&V2&", "&V3&" ... in den Langtext eingesetzt werden. Durch die Ziffer wird auf den entsprechenden Feldinhalt der hinter WITH aufgelisteten Feldinhalte Bezug genommen. Meldungen werden im ABAP/4 im Modulpool durch die MESSAGE-Anweisung abgesetzt.

top