Twórz przydatne komunikaty o błędach

Na tej stronie znajdziesz sprawdzone metody pisania przydatnych komunikatów o błędach, które zawierają informacje o tym, jak rozwiązać problem, aby osiągnąć zamierzony cel.

Komunikaty o błędach, które nie pozwalają na podjęcie działania, mogą być frustrujące podczas interakcji użytkownika z aplikacją Google Chat. Na przykład komunikat o błędzie (An error occurred) nie jest przydatny, ponieważ nie zawiera informacji o tym, co poszło nie tak, jak użytkownik może rozwiązać problem ani jak może uzyskać pomoc. Na tej stronie opisujemy, jak uporządkować komunikaty o błędach w taki sposób, aby były przydatne dla użytkowników, pokazując przykłady użytecznych i niemożliwych do działania przykładów.

Struktura komunikatu o błędzie

Komunikat o błędzie zachęcający do działania ma taką strukturę:

  • Co poszło nie tak. Wytłumaczenie, dlaczego aplikacja Google Chat nie może zrealizować żądania, pomaga użytkownikowi rozwiązać problem. Wyjaśnienie, dlaczego błąd zdobywa zaufanie.
  • Jak użytkownik może przejść do celu. Nie wystarczy powiedzieć, co poszło nie tak. Powiedz użytkownikom, jak mogą uniknąć błędu i osiągnąć cel.
  • Jak uzyskać pomoc Jeśli użytkownik nadal ma problem, powiedz mu, jak może uzyskać dodatkową pomoc. Może to być polecenie /help lub link do dokumentacji aplikacji Google Chat.

Przykładowy komunikat o błędzie: nieprawidłowy format daty

W tym przykładzie użytkownik podał datę w formacie, którego aplikacja do obsługi czatu nie oczekiwała. Użyli nazwy November 19, 2021, a aplikacja Google Chat oczekuje 2021-11-19.

Oto przykładowa i nieaktywna wersja komunikatu o błędzie, na który reaguje aplikacja Google Chat:

Błąd, który można wykonać

Użytkownik prosi aplikację Google Chat o zaplanowanie spotkania z inną osobą. Aplikacja Google Chat wyświetla w odpowiedzi trafny komunikat o błędzie:

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

Przykładowy komunikat o błędzie, który informuje użytkownika, co poszło nie tak, jak kontynuować i jak uzyskać pomoc.

Komunikat ten umożliwia podjęcie działania z tych powodów:

  • Opisuje, co poszło nie tak. Aplikacja Google Chat nie rozpoznaje formatu daty.
  • Objaśnia, jak naprawić błąd, podając użytkownikowi oczekiwany format daty, i poda przykładową datę, która pomoże użytkownikom zrozumieć, co ma napisać.
  • Zapewnia dodatkową pomoc przy użyciu polecenia po ukośniku /help. Jeśli użytkownicy nadal utknęli, wiedzą, jak uzyskać więcej informacji.

Błąd dotyczący braku możliwości podjęcia działania

Użytkownik prosi aplikację Google Chat o zaplanowanie spotkania z inną osobą. Aplikacja Google Chat w odpowiedzi wyświetla nieprzydatny komunikat o błędzie, który uniemożliwia podjęcie działania:

Enter the correct date format.

Przykładowy komunikat o błędzie, który nie zawiera przydatnych informacji.

Nie można podjąć działania w związku z tym komunikatem o błędzie z tych powodów:

  • Nie podaje, czy zostało zaplanowane spotkanie. Użytkownik może wahać się, czy przełożyć spotkanie, lub przypuszczać, że spotkanie było zaplanowane.
  • Nie informuje użytkownika, jak formatować datę. Zamiast zakładać, że użytkownicy wiedzą, jak sformatować datę, należy jej przyznać, że spodziewany jest format daty yyyy-mm-dd.
  • nie oferuje dodatkowej pomocy; Gdy użytkownicy utkną i nie wiedzą, co zrobić dalej, mogą przestać wysyłać wiadomości do aplikacji Google Chat.

Wypróbuj

Teraz gdy już wiesz, jak pisać przydatne błędy, zastanów się, które z nich wymagają podjęcia działania w tym scenariuszu:

Aplikacja do obsługi czatu tworzy wydarzenia w kalendarzu, gdy użytkownicy wysyłają do aplikacji Google Chat słowo kluczowe schedule. Aby utworzyć wydarzenie w kalendarzu, aplikacja Google Chat wymaga uwierzytelniania użytkownika. Jeśli użytkownik nie został uwierzytelniony, aplikacja Google Chat w odpowiedzi wyświetli komunikat o błędzie.

Który komunikat o błędzie wymaga działania?
Zanim zaplanuję spotkanie, musisz się zalogować, wpisując /signin. Aby dowiedzieć się więcej, wpisz /help.
Ten komunikat o błędzie umożliwia podjęcie działania, ponieważ zawiera on te informacje:
  • Co poszło nie tak. Aplikacja Google Chat wymaga uwierzytelnienia.
  • Co zrobić. Aby uwierzytelnić, wpisz /signin.
  • Jak uzyskać pomoc Jeśli użytkownik chce uzyskać więcej informacji, może wpisać /help.
Musisz się uwierzytelnić.
Nie można podjąć działania, ponieważ nie zawiera informacji o sposobie uwierzytelniania.
Zaloguj się.
Ten komunikat o błędzie nie zawiera żadnych działań, ponieważ nie zawiera informacji o tym, jak się zalogować, a nie oznacza, że użytkownik jest wylogowany, co jest mylące.
Nie udało się zaplanować spotkania.
Ten komunikat o błędzie nie wymaga podjęcia działania, ponieważ nie zawiera on informacji dla użytkownika, dlaczego nie można zaplanować spotkania ani jak może on kontynuować. Nie zapewniamy pomocy.