Umsetzbare Fehlermeldungen schreiben

Auf dieser Seite werden Best Practices zum Verfassen umsetzbarer Fehlermeldungen beschrieben, die Nutzern mitteilen, wie sie das Problem beheben müssen, damit sie ihr Ziel erreichen können.

Wenn ein Nutzer mit einer Google Chat-App interagiert, kann es frustrierend sein, Fehlermeldungen zu erhalten, wenn der Fehler nicht behoben werden kann. Die Fehlermeldung An error occurred ist beispielsweise nicht hilfreich, da sie nicht erklärt, was schiefgelaufen ist, wie der Nutzer das Problem beheben oder wie er Hilfe erhalten kann. Auf dieser Seite wird beschrieben, wie Fehlermeldungen so strukturiert werden, dass sie für Nutzer hilfreich sind. Dazu werden handlungsrelevante und nicht umsetzbare Beispiele gezeigt.

Struktur der Fehlermeldung

Eine umsetzbare Fehlermeldung hat die folgende Struktur:

• Was ist schiefgelaufen? Wenn Sie angeben, warum die Chat-App eine Anfrage nicht ausführen kann, hilft dem Nutzer, das Problem zu beheben. Die Erklärung, warum ein Fehler auftrat, schafft Vertrauen.
• Wie die Nutzer ihr Ziel erreichen können. Es reicht nie aus, einfach zu sagen, was schiefgelaufen ist. Teilen Sie den Nutzenden mit, wie sie den Fehler überwinden und ihr Ziel erreichen können.
• Hilfe Wenn der Nutzer immer noch nicht weiterkommt, sagen Sie ihm, wo er weitere Hilfe erhalten kann. Dies kann ein /help-Befehl oder ein Link zur Dokumentation für Ihre Chat-App sein.

Beispiel für eine Fehlermeldung: falsches Datumsformat

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

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

Behebbarer 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`.

Für diese Fehlermeldung gibt es folgende Gründe:

• Sagt, was schiefgelaufen ist. Die Chat-App erkennt das Datumsformat nicht.
• Hier wird erläutert, wie Sie den Fehler beheben, indem Sie dem Nutzer das erwartete Datumsformat nennen. Außerdem wird ein Beispieldatum genannt, das Nutzern hilft, zu verstehen, was sie schreiben sollen.
• Bietet weitere Hilfe mit dem Slash-Befehl /help. Wenn Nutzende immer noch nicht weiterkommen, wissen sie, wie sie mehr erfahren können.

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.

Für diese Fehlermeldung ist aus folgenden Gründen keine Aktion möglich:

• Es wird nicht angegeben, ob die Besprechung geplant wurde. Der Nutzer zögert möglicherweise, die Besprechung zu verschieben, oder nimmt an, dass die Besprechung geplant ist.
• Zeigt Nutzenden nicht, wie das Datum formatiert werden soll. Anstatt anzunehmen, dass Nutzer wissen, wie das Datum formatiert wird, sollte angegeben werden, dass das Datumsformat yyyy-mm-dd erwartet wird.
• Bietet keine weitere Hilfe. Wenn Nutzer nicht weiterkommen und nicht wissen, wie sie fortfahren sollen, senden sie möglicherweise keine Nachrichten mehr an die Chat-App.

Ausprobieren

Sie wissen nun, wie Sie Fehler für Fehler schreiben. Können Sie im folgenden Szenario herausfinden, welcher der folgenden Fehler behoben werden kann:

Eine Chat-App erstellt Kalendertermine, wenn Nutzer eine Nachricht mit dem Suchbegriff schedule an die Chat-App senden. Zum Erstellen eines Kalendertermins benötigt die Chat-App die Nutzerauthentifizierung. Wenn ein Nutzer nicht authentifiziert wurde, antwortet die Chat-App mit einer Fehlermeldung.