Пишите действенные сообщения об ошибках

На этой странице описаны лучшие практики написания информативных сообщений об ошибках, которые подскажут пользователю, как исправить проблему, чтобы он мог достичь своей цели.

When a user is interacting with a Google Chat app, encountering error messages can be a frustrating experience when the error isn't actionable. For example, the error message, An error occurred , isn't useful because the message doesn't explain what went wrong, how the user can fix the issue, or how the user can get help. This page describes how to structure error messages so that they're useful to users by showing actionable and inactionable examples.

Структура сообщения об ошибке

Сообщаемое сообщение об ошибке имеет следующую структуру:

• Что пошло не так? Объяснение причины, по которой приложение чата не может выполнить запрос, помогает пользователю решить проблему. Пояснение причин ошибки укрепляет доверие.
• Как пользователь может продвинуться к своей цели. Недостаточно просто сказать, что пошло не так. Расскажите пользователям, как они могут преодолеть ошибку и достичь своей цели.
• Как получить помощь. Если пользователь по-прежнему не может получить помощь, объясните ему, как он может получить более подробную информацию. Это может быть команда /help или ссылка на документацию вашего чат-приложения.

Пример сообщения об ошибке: неверный формат даты

In this example, the user entered a date in a format that the Chat app didn't expect. They wrote November 19, 2021 , but the Chat app expects 2021-11-19 .

Вот вариант сообщения об ошибке, в котором приложение чата выдает сообщение, требующее и не требующее действий:

Ошибка, требующая принятия мер

Пользователь просит приложение «Чат» назначить встречу с другим человеком. Приложение «Чат» выдает понятное и информативное сообщение об ошибке:

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

Данное сообщение об ошибке требует принятия мер по следующим причинам:

• Указывается, что пошло не так. Приложение «Чат» не распознает формат даты.
• Объясняет, как исправить ошибку, указывая пользователю ожидаемый формат даты и приводя пример даты, который помогает понять, что нужно написать.
• Дополнительная помощь предоставляется с помощью команды /help . Если у пользователей по-прежнему возникают трудности, они знают, как получить более подробную информацию.

Ошибка, не требующая принятия мер

Пользователь просит приложение «Чат» назначить встречу с другим человеком. Приложение «Чат» отвечает бесполезным и неэффективным сообщением об ошибке:

Enter the correct date format.

Данное сообщение об ошибке не позволяет предпринять никаких действий по следующим причинам:

• Не указано, была ли назначена встреча. Пользователь может колебаться, стоит ли переносить встречу, или он может предположить, что встреча уже назначена.
• В этом сообщении не указано, как форматировать дату. Вместо того чтобы предполагать, что пользователи знают, как форматировать дату, следует указать, что ожидается формат даты yyyy-mm-dd .
• Не предлагает дополнительной помощи. Когда пользователи застревают и не знают, как действовать дальше, они могут перестать отправлять сообщения в чате.

Попробуйте!

Теперь, когда вы знаете, как описывать ошибки, требующие принятия мер, можете ли вы в следующем сценарии определить, какая из этих ошибок требует принятия мер:

Приложение для чата создает события календаря, когда пользователи отправляют в него сообщение с ключевым словом « schedule . Для создания события календаря приложению для чата требуется аутентификация пользователя. Если пользователь не аутентифицирован, приложение для чата выдает сообщение об ошибке.