Umsetzbare Fehlermeldungen schreiben

Auf dieser Seite werden Best Practices zum Schreiben umsetzbarer Fehlermeldungen beschrieben, die wie das Problem behoben werden kann, damit es sein Ziel erreichen kann.

Wenn ein Nutzer mit einer Google Chat-App interagiert, Fehlermeldungen können frustrierend sein, wenn der Fehler nicht behoben werden kann. Die Fehlermeldung An error occurred ist beispielsweise nicht hilfreich, weil der Fehler wird nicht erklärt, was schiefgelaufen ist, wie der Nutzer das Problem beheben kann damit der Nutzer Hilfe erhalten kann. Auf dieser Seite wird beschrieben, wie Sie Fehlermeldungen so strukturieren, dass sie für Nutzende nützlich sind, indem sie praxisnahe und nicht umsetzbare Beispiele zeigen.

Struktur der Fehlermeldungen

Eine Fehlermeldung, die eine Aktion durchführen kann, hat die folgende Struktur:

• Fehler: Sie erklären, warum die Chat-App nicht Das Abschließen einer Anfrage hilft dem Nutzer, das Problem zu beheben. Erklären, warum ein Fehler baut Vertrauen auf.
• Wie Nutzer auf dem Weg zu ihrem Ziel vorgehen können. Es reicht nie aus, was schiefgelaufen ist. Teilen Sie den Nutzenden mit, wie sie den Fehler überwinden und den Vorgang abschließen können. zu erreichen.
• Hilfe Wenn der Nutzer immer noch nicht weiterkommt, erklären Sie ihm, wie er weitere Hilfe. Dies kann ein /help-Befehl oder ein Link zur Dokumentation für Ihre Chat-App.

Beispiel für Fehlermeldung: Falsches Datumsformat

In diesem Beispiel hat der Nutzer ein Datum in einem Format eingegeben, nicht mit der Chat-App gerechnet hat. Sie schrieb November 19, 2021, aber die Chat App erwartet 2021-11-19.

Hier ist eine entscheidungsrelevante Version der Fehlermeldung, Die Chat-App antwortet mit:

Behebbarer Fehler

Ein Nutzer bittet die Chat App, eine Besprechung mit eine andere Person. Die Chat-App antwortet mit einer Fehlermeldung mit möglichen Maßnahmen:

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 Google Chat App das Datumsformat zu erkennen.
• Erläutert, wie der Fehler behoben werden kann, indem dem Nutzer das erwartete Datumsformat mitgeteilt wird und gibt ein Beispieldatum an, das den Lesern hilft, zu verstehen, was sie schreiben sollen.
• Bietet weitere Hilfe mit einem /help-Slash-Befehl. Wenn Nutzende immer noch nicht weiterkommen, wissen sie, wo sie mehr erfahren können.

Fehler, der nicht bearbeitet werden kann

Ein Nutzer bittet die Chat App, eine Besprechung mit eine andere Person. Die Chat-App antwortet mit einer nicht hilfreiche, nicht umsetzbare Fehlermeldung:

Enter the correct date format.

Diese Fehlermeldung kann aus den folgenden Gründen nicht bearbeitet werden:

• Es wird nicht mitgeteilt, ob die Besprechung geplant wurde. Die Nutzenden zögern möglicherweise, oder sie gehen davon aus, dass sie angesetzt war.
• Dem Nutzer wird nicht mitgeteilt, wie das Datum formatiert werden soll. Anstatt anzunehmen, wenn Nutzende wissen, wie das Datum formatiert werden muss, Datumsformat: yyyy-mm-dd.
• Es wird keine weitere Hilfe angeboten. Wenn Nutzende nicht weiterkommen und nicht wissen, wie sie vorgehen sollen, kann es sein, dass sie keine Nachrichten mehr an die Chat-App senden.

Jetzt ausprobieren

Da Sie nun wissen, wie Sie umsetzbare Fehler schreiben, können Sie im folgenden Szenario, welcher der folgenden Fehler behoben werden kann:

Eine Chat-App erstellt Kalendertermine, wenn Nutzer Nachrichten senden die Chat-App mit dem Schlüsselwort schedule. Bis Kalendertermin erstellen, müssen Nutzer in der Chat-App Authentifizierung. Wenn ein Nutzer nicht authentifiziert wurde, ist der Die Chat-App antwortet mit einer Fehlermeldung.