Richtlinien für Fehlermeldungen

Eine Fehlermeldung ist ein Text, der angezeigt wird, um ein aufgetretenes Problem zu beschreiben, das den Benutzer oder das System daran hindert, eine Aufgabe abzuschließen. Das Problem kann zu Datenbeschädigungen oder -verlusten führen. Andere Nachrichtentypen umfassen Bestätigungen, Warnungen und Benachrichtigungen. Die Richtlinien in diesem Thema sollen Ihnen helfen, eindeutige Fehlermeldungen zu schreiben, die einfach zu lokalisieren und für Kunden nützlich sind.

Schlecht geschriebene Fehlermeldungen können für Benutzer frustriert sein und die Kosten für den technischen Support erhöhen. Eine gut geschriebene Fehlermeldung enthält die folgenden Informationen für den Benutzer:

• Was ist passiert und warum?
• Was ist das Endergebnis für den Benutzer?
• Was kann der Benutzer tun, um zu verhindern, dass dies erneut geschieht?

Die Länge des Texts ist kein Problem, solange der Entwickler Puffergrößen ordnungsgemäß behandelt. Es ist wichtig, dass der Benutzer über alle Informationen verfügt, die zum Lösen des Problems erforderlich sind. Wenn eine Nachricht mehrere Zielgruppen hat, müssen Sie möglicherweise separaten Text für Administratoren, Endbenutzer und Entwickler bereitstellen.

Bewährte Methoden

Im Folgenden finden Sie Möglichkeiten, Ihre Fehlermeldungen zu verbessern:

• Vermeiden Sie Fehlerbedingungen. Wenn Sie vorhersagen können, dass ein Fehler auftritt, wenn ein Benutzer eine bestimmte Aktion ausführt, schreiben Sie Den Code neu, damit der Benutzer den Fehler nicht verursachen kann.
• Schreiben Sie für jede bekannte Fehlerursache eine separate Fehlermeldung. Verwenden Sie keine einzige generische Meldung, um jeden möglichen Grund für den Fehler zu erläutern, es sei denn, Sie können die Ursache des Fehlers nicht ermitteln, wenn er auftritt.
• Geben Sie das Problem klar an, und erläutern Sie, wenn es für den Benutzer hilfreich ist, was das Problem verursacht hat. Ersetzen Sie nach Möglichkeit die generischen Nachrichten aus den Systemnachrichtentabellenressourcen durch eine detaillierte Meldung, die für das Problem spezifisch ist.
• Stellen Sie dem Benutzer eine Lösung für das Problem bereit. Wenn die Lösung mehr als einen Schritt umfasst, lesen Sie ein Hilfethema, in dem die Aufgabe ausführlich erläutert wird.
• Zeigt nur den Namen des Produkts, der Komponente oder des Assistenten in der Titelleiste der Nachricht an. Dies hilft dem Benutzer, zu bestimmen, wo das Problem liegt. Fassen Sie das Problem nicht in der Titelleiste zusammen, oder fügen Sie das Wort "Error" ein.
• Verwenden Sie keinen technischen Jargon, und verwenden Sie Terminologie, die Ihre Zielgruppe versteht. Verwenden Sie keinen Slang oder Abkürzungen.
• Verwenden Sie die entsprechenden Befehlsschaltflächen, z. B. OK, Abbrechen, Ja, Nein und Wiederholen. Sie können Kombinationen dieser Schaltflächen verwenden. Die Schaltflächen "Ja" und "Nein" müssen immer in Kombination verwendet werden und müssen immer einer Frage vorangestellt werden.
  • Verwenden Sie die Schaltfläche Abbrechen , um einen Vorgang zu beenden und das Meldungsfeld zu schließen.
  • Um ein Meldungsfeld zu schließen, verwenden Sie die Schaltfläche Schließen .
  • Um weitere Informationen zur Fehlerursache bereitzustellen, verwenden Sie die Schaltfläche Details .
  • Um weitere Informationen zur Lösung des Problems bereitzustellen, verwenden Sie die Schaltfläche Hilfe .
  • Wenn eine Benutzeraktion in der Nachricht enthalten ist, verwenden Sie die Schaltfläche OK , um das Meldungsfeld zu schließen.
  • Die Schaltflächen "Ja" und "Nein" müssen in Kombination verwendet werden und müssen immer eine Frage vorangestellt werden.
• Wenn der Fehler ein kritischer Fehler ist, schreiben Sie ihn in das Ereignisprotokoll.

Überlegungen zum Stil

• Verwenden Sie vollständige, aber einfache Sätze.
• Verwenden Sie die aktuelle Zeit, um die Bedingungen zu beschreiben, die das Problem verursacht haben, oder einen Zustand, der noch vorhanden ist. Sie können die Vergangenheitsform verwenden, um ein eindeutiges Ereignis zu beschreiben, das in der Vergangenheit aufgetreten ist.
• Verwenden Sie nach Möglichkeit aktive Stimme. Sie können passive Stimme verwenden, um die Fehlerbedingung zu beschreiben.
• Vermeiden Sie Großbuchstaben und Ausrufezeichen.
• Geben Sie dem Benutzer nicht das Gefühl, dass ein Fehler vorliegt, auch wenn das Problem das Ergebnis eines Benutzerfehlers ist.
• Nicht anthropomorphisieren. Implizieren Sie nicht, dass Programme oder Hardware denken oder fühlen können.
• Verwenden Sie keine umgangssprachlichen Wörter oder Ausdrücke. Verwenden Sie keine Begriffe, die in bestimmten Kulturen anstößig sein können.
• Fügen Sie nicht mehrere Nomen hinzu, ohne eine Präposition oder Subclause hinzuzufügen, um die Bedeutung zu verdeutlichen. Beispielsweise sollte "Verzeichnisserver des LDAP-Diensts des Standortservers" in "Verzeichnisserver für den LDAP-Dienst des Standortservers" geändert werden.
• Fügen Sie Deskriptoren vor einem Begriff ein, um die Bedeutung des Satzes zu verdeutlichen. Beispielsweise sollte "InfID angeben, wenn Erkennen auf Nein festgelegt ist" in "Geben Sie den InfID-Parameter an, wenn die Option Erkennen auf Nein festgelegt ist".
• Vermeiden Sie das Wort "bad". Verwenden Sie aussagekräftigere Begriffe, um dem Benutzer mitzuteilen, was falsch ist. Vermeiden Sie beispielsweise Nachrichten wie "Ungültige Größe". Teilen Sie dem Benutzer stattdessen mit, welche Kriterien beim Angeben einer Größe verwendet werden sollen.
• Vermeiden Sie das Wort "bitte". Dies kann so interpretiert werden, dass eine erforderliche Aktion optional ist.
• Platzieren Sie Wörter, die sowohl im Index als auch für die zentrale Bedeutung relevant sind, am Anfang der Nachrichtenzeichenfolge.