Umsetzbare Fehlermeldungen schreiben

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

Wenn ein Nutzer mit einer Google Chat-Anwendung interagiert, kann es frustrierend sein, Fehlermeldungen zu erhalten, wenn der Fehler nicht behebbar ist. Die Fehlermeldung An error occurred ist beispielsweise nicht hilfreich, da darin nicht erläutert wird, was schiefgelaufen ist, wie der Nutzer das Problem beheben kann oder wie er Hilfe erhalten kann. Auf dieser Seite wird beschrieben, wie Fehlermeldungen anhand von umsetzbaren und nicht umsetzbaren Beispielen so strukturiert werden können, dass sie für Nutzer hilfreich sind.

Struktur der Fehlermeldung

Eine umsetzbare Fehlermeldung hat folgende Struktur:

• Was ist schiefgelaufen? Wenn Sie angeben, warum die Chat-App eine Anfrage nicht ausführen kann, kann der Nutzer das Problem leichter beheben. Zu erklären, warum ein Fehler auftrat, schafft Vertrauen.
• Wie kann der Nutzer sein Ziel erreichen? Es reicht nie aus, 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 von der Chat-App nicht erwartet wurde. 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`.

Diese Fehlermeldung kann aus folgenden Gründen bearbeitet werden:

• Sagt, was schiefgelaufen ist. Die Chat-App erkennt das Datumsformat nicht.
• Erläutert, wie sich der Fehler beheben lässt, indem Nutzern das erwartete Datumsformat mitgeteilt wird, und ein Beispieldatum, das Nutzern hilft, zu verstehen, was sie schreiben sollen
• Bietet weitere Hilfe mit dem Slash-Befehl /help. Wenn Nutzende immer noch nicht weiterkommen, können sie sich weiter informieren.

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.

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

• Er sagt nicht, ob die Besprechung geplant wurde. Der Nutzer zögert möglicherweise, die Besprechung zu verschieben, oder nimmt an, dass die Besprechung geplant wurde.
• Sie sagt dem Nutzer nicht, wie das Datum formatiert werden soll. Anstatt anzunehmen, dass Nutzer wissen, wie das Datum formatiert werden kann, 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, beenden sie möglicherweise das Senden von Nachrichten an die Chat-App.

Ausprobieren

Nachdem Sie nun wissen, wie Sie umsetzbare Fehler schreiben, können Sie im folgenden Szenario ermitteln, welche dieser Fehler ausführbar sind:

Eine Chat-App erstellt Kalendertermine, wenn Nutzer eine Nachricht mit dem Suchbegriff schedule an die Chat-App senden. Zum Erstellen eines Kalendertermins ist für die Chat-Anwendung eine Nutzerauthentifizierung erforderlich. Wenn ein Nutzer nicht authentifiziert wurde, antwortet die Chat-Anwendung mit einer Fehlermeldung.