Umsetzbare Fehlermeldungen schreiben

Auf dieser Seite werden Best Practices für das Schreiben von umsetzbaren Fehlermeldungen beschrieben, die dem Nutzer zeigen, wie er das Problem beheben kann, damit er sein Ziel erreichen kann.

Wenn ein Nutzer mit einer Google Chat-App interagiert und auf nicht umsetzbare Fehlermeldungen stößt, kann das frustrierend sein. Die Fehlermeldung An error occurred ist beispielsweise nicht hilfreich, da sie nicht erklärt, was schiefgelaufen ist, wie der Nutzer das Problem beheben kann oder wie er Hilfe erhalten kann. Auf dieser Seite wird beschrieben, wie Sie Fehlermeldungen so strukturieren, dass sie für Nutzer nützlich sind. Dazu werden Beispiele für umsetzbare und nicht umsetzbare Meldungen gezeigt.

Struktur von Fehlermeldungen

Eine umsetzbare Fehlermeldung hat die folgende Struktur:

  • Was ist schiefgelaufen? Wenn Sie angeben, warum die Chatanwendung eine Anfrage nicht ausführen kann, helfen Sie dem Nutzer, das Problem zu beheben. Wenn Sie erklären, warum ein Fehler aufgetreten ist, schaffen Sie Vertrauen.
  • Wie der Nutzer sein Ziel erreichen kann. Es reicht nie aus, nur zu sagen, was schiefgelaufen ist. Erklären Sie den Nutzern, wie sie den Fehler beheben und ihr Ziel erreichen können.
  • Hilfe erhalten Wenn der Nutzer immer noch nicht weiterkommt, erkläre ihm, wie er weitere Hilfe erhalten kann. Das kann ein /help-Befehl oder ein Link zur Dokumentation für Ihre Chat-App sein.

Beispiel für Fehlermeldung: Falsches Datumsformat

In diesem Beispiel hat der Nutzer ein Datum in einem Format eingegeben, das von der Chat-App nicht erwartet wurde. Sie haben November 19, 2021 geschrieben, aber die Chat App erwartet 2021-11-19.

Hier sind eine umsetzbare und eine nicht umsetzbare Version der Fehlermeldung, mit der die Chat-App antwortet:

Umsetzbarer Fehler

Ein Nutzer bittet die Chat-App, eine Besprechung mit einer anderen Person zu planen. Die Chat-App antwortet mit einer guten, umsetzbaren Fehlermeldung:

I don't recognize the date format you entered. Write dates as `yyyy-mm-dd`; for example, `2000-01-31`. For help, type `/help`.

Beispiel für eine Fehlermeldung, die dem Nutzer mitteilt, was schiefgelaufen ist, wie er vorgehen soll und wie er Hilfe erhalten kann.

Diese Fehlermeldung ist aus folgenden Gründen relevant:

  • Hier wird beschrieben, was schiefgelaufen ist. Das Datumsformat wird von der Chat App nicht erkannt.
  • Es wird erklärt, wie der Fehler behoben werden kann. Dazu wird dem Nutzer das erwartete Datumsformat mitgeteilt und ein Beispieldatum angegeben, damit er weiß, was er eingeben muss.
  • Bietet mehr Hilfe mit dem Slash-Befehl /help. Wenn Nutzer immer noch nicht weiterkommen, wissen sie, wo sie weitere Informationen finden.

Nicht behebbarer Fehler

Ein Nutzer bittet die Chat-App, eine Besprechung mit einer anderen Person zu planen. Die Chat-App antwortet mit einer nicht hilfreichen, nicht umsetzbaren Fehlermeldung:

Enter the correct date format.

Beispiel für eine Fehlermeldung, die keine verwertbaren Informationen enthält.

Diese Fehlermeldung kann aus folgenden Gründen nicht behoben werden:

  • Es wird nicht angegeben, ob die Besprechung geplant wurde. Der Nutzer zögert möglicherweise, die Besprechung zu verschieben, oder geht davon aus, dass die Besprechung geplant wurde.
  • Es wird nicht erklärt, wie das Datum formatiert werden soll. Anstatt davon auszugehen, dass Nutzer wissen, wie das Datum formatiert werden muss, sollte angegeben werden, dass das Datumsformat yyyy-mm-dd erwartet wird.
  • Bietet keine weitere Hilfe. Wenn Nutzer nicht weiterwissen, senden sie möglicherweise keine Nachrichten mehr an die Chat-App.

Jetzt ausprobieren

Jetzt, da Sie wissen, wie Sie umsetzbare Fehler schreiben, können Sie im folgenden Szenario erkennen, welcher dieser Fehler umsetzbar ist:

Eine Chat-App erstellt Kalendertermine, wenn Nutzer der Chat-App eine Nachricht mit dem Keyword schedule senden. Zum Erstellen eines Kalendertermins ist eine Nutzerauthentifizierung in der Chat App erforderlich. Wenn ein Nutzer nicht authentifiziert wurde, antwortet die Chat-App mit einer Fehlermeldung.

Welche Fehlermeldung ist umsetzbar?
Bevor ich die Videokonferenz planen kann, müssen Sie sich mit /signin anmelden. Wenn Sie mehr erfahren möchten, geben Sie /help ein.
Diese Fehlermeldung ist umsetzbar, da sie Folgendes besagt:
  • Was ist schiefgelaufen? Für die Chat App ist eine Authentifizierung erforderlich.
  • Vorgehensweise Geben Sie /signin ein, um sich zu authentifizieren.
  • So erhalten Sie Hilfe. Wenn der Nutzer weitere Informationen wünscht, kann er /help eingeben.
Sie müssen sich authentifizieren.
Diese Fehlermeldung ist nicht umsetzbar, da nicht angegeben wird, wie die Authentifizierung erfolgen soll.
Melden Sie sich an.
Diese Fehlermeldung ist nicht hilfreich, da nicht angegeben wird, wie man sich anmeldet. Außerdem wird angedeutet, dass der Nutzer abgemeldet ist, anstatt dies klar zu sagen. Das ist verwirrend.
Besprechung kann nicht geplant werden.
Diese Fehlermeldung ist nicht hilfreich, da sie dem Nutzer nicht mitteilt, warum die Besprechung nicht geplant werden kann oder wie er vorgehen soll. Es wird keine Hilfe angeboten.