Freigeben über

Richtlinien für Fehlermeldungen

  • Artikel

Eine Fehlermeldung ist Text, der angezeigt wird, um ein Problem zu beschreiben, das aufgetreten ist, das verhindert, dass der Benutzer oder das System eine Aufgabe abschließen kann. Das Problem könnte zu Datenbeschädigung oder -verlust führen. Andere Nachrichtentypen umfassen Bestätigungen, Warnungen und Benachrichtigungen. Die Richtlinien in diesem Thema sollen Ihnen helfen, klare Fehlermeldungen zu schreiben, die für Kunden leicht zu lokalisieren und nützlich sind.

Schlecht geschriebene Fehlermeldungen können eine Ursache für Frustration für Benutzer sein und die Kosten des technischen Supports erhöhen. Eine gut geschriebene Fehlermeldung stellt dem Benutzer die folgenden Informationen bereit:

  • Was ist passiert und warum?
  • Was ist das Endergebnis für den Benutzer?
  • Was kann der Benutzer tun, um zu verhindern, dass er wieder auftritt?

Die Textlänge ist kein Problem, solange der Entwickler Puffergrößen richtig verarbeitet. Es ist wichtig, dass der Benutzer über alle Informationen verfügt, die zum Lösen des Problems erforderlich sind. Wenn eine Nachricht über mehrere Benutzergruppen verfügt, 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 eine separate Fehlermeldung für jede bekannte Ursache des Fehlers. Verwenden Sie keine einzige generische Meldung, um jeden möglichen Grund für den Fehler zu erklären, es sei denn, Sie können die Ursache des Fehlers nicht ermitteln, wenn er auftritt.
  • Geben Sie das Problem eindeutig an, und erklären Sie, wenn es für den Benutzer hilfreich sein wird, was das Problem verursacht hat. Ersetzen Sie nach Möglichkeit die generischen Nachrichten aus den Systemnachrichtentabellenressourcen durch eine detaillierte Nachricht, 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 enthält, lesen Sie ein Hilfethema, in dem die Aufgabe ausführlich erläutert wird.
  • Zeigen Sie nur den Namen des Produkts, der Komponente oder des Assistenten in der Titelleiste der Nachricht an. Dies hilft dem Benutzer zu bestimmen, wo sich das Problem befindet. Fassen Sie das Problem nicht in der Titelleiste zusammen, oder fügen Sie das Wort "Fehler" ein.
  • Verwenden Sie keinen technischen Jargon, verwenden Sie Terminologie, die Ihr Publikum versteht. Verwenden Sie keine Slang oder Abkürzungen.
  • Verwenden Sie die entsprechenden Befehlsschaltflächen wie "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.
    • Um einen Vorgang zu beenden und das Meldungsfeld zu schließen, verwenden Sie die Schaltfläche Abbrechen.
    • Verwenden Sie zum Schließen eines Meldungsfelds die Schaltfläche Schließen.
    • Um weitere Informationen zur Ursache des Fehlers bereitzustellen, verwenden Sie die Schaltfläche Details.
    • Wenn Sie weitere Informationen zur Lösung des Problems bereitstellen möchten, 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.
    • Ja- und Schaltflächen "Nein" müssen in Kombination verwendet werden und müssen immer einer Frage vorangestellt werden.
  • Wenn der Fehler ein kritischer Fehler ist, schreiben Sie ihn in das Ereignisprotokoll.

Überlegungen zu Stilen

  • Verwenden Sie vollständige, aber einfache Sätze.
  • Verwenden Sie den vorliegenden Zug, um die Bedingungen zu beschreiben, die das Problem verursacht haben, oder einen Zustand, der noch vorhanden ist. Sie können past tense verwenden, um ein bestimmtes 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 Text und Ausrufezeichen in Großbuchstaben.
  • Machen Sie den Benutzer nicht selbst dann fehlerhaft, 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 Substantive hinzu, ohne eine Präposition oder Unterclause hinzuzufügen, um die Bedeutung zu verdeutlichen. Beispielsweise sollte "Verzeichnisserver des Siteserver-LDAP-Dienstverzeichnisses" in "Verzeichnisserver für den LDAP-Dienst des Standortservers" geändert werden.
  • Fügen Sie Deskriptoren vor einem Ausdruck ein, um die Bedeutung des Satzes zu verdeutlichen. Beispielsweise sollte "InfID angeben, wenn die Erkennung auf "Nein" festgelegt ist, in "Angeben des InfID-Parameters, wenn die Erkennungsoption auf "Nein" festgelegt ist, geändert werden.
  • Vermeiden Sie das Wort "schlecht". Verwenden Sie aussagekräftigere Begriffe, um dem Benutzer mitzuteilen, was falsch ist. Vermeiden Sie beispielsweise Nachrichten wie "Schlechte Größe". Teilen Sie dem Benutzer stattdessen mit, welche Kriterien beim Angeben einer Größe verwendet werden sollen.
  • Vermeiden Sie das Wort "bitte". Es kann interpretiert werden, um zu bedeuten, dass eine erforderliche Aktion optional ist.
  • Platzieren Sie Wörter, die sich sowohl im Index befinden als auch für die zentrale Bedeutung am Anfang der Nachrichtenzeichenfolge relevant sind.