编写可操作的错误消息

本页面介绍了编写可操作错误消息的最佳实践,告知用户如何解决问题以便完成目标。

当用户与 Google Chat 应用互动时,如果遇到无法解决的错误,那么看到错误消息可能会令人沮丧。例如,错误消息 An error occurred 没有用处,因为该消息没有说明问题所在、用户如何解决问题或者用户如何获取帮助。本页介绍了如何设计错误消息的结构,以便通过显示可操作且无法作为操作的示例来对用户有用。

错误消息结构

可操作的错误消息的结构如下:

  • 哪里出错了。说明 Chat 应用无法完成请求的原因有助于用户解决问题。解释出错的原因可建立信任。
  • 用户可以如何实现目标。仅仅说错误出在哪里还不够告诉用户如何才能跳过错误并完成目标。
  • 如何获取帮助。如果用户仍然遇到问题,请告诉他们如何获取更多帮助。这可以是 /help 命令或指向 Chat 应用文档的链接。

错误消息示例:日期格式不正确

在此示例中,用户以 Chat 应用未预期的格式输入了日期。他们写入了 November 19, 2021,但 Chat 应用要求为 2021-11-19

以下是 Chat 应用响应的错误消息的可操作版本和不可操作版本:

可操作的错误

用户要求 Chat 应用安排与其他人的会议。Chat 应用会返回一条实用且实用的错误消息:

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

向用户说明哪里出错了、如何继续操作以及如何获取帮助的示例错误消息。

此错误消息是可行的,原因如下:

  • 说明出了什么问题。Chat 应用无法识别日期格式。
  • 通过告知用户预计的日期格式来修复错误,并提供一个示例日期,帮助用户了解要写入的内容。
  • 通过 /help 斜杠命令提供更多帮助。如果用户仍然遇到困难,他们知道如何了解更多信息。

不可处理的错误

用户要求 Chat 应用安排与其他人的会议。该 Chat 应用会返回一条没有帮助且无法解决的错误消息:

Enter the correct date format.

未提供实用信息的错误消息示例。

此错误消息无法进行处理,原因如下:

  • 未说明会议是否已安排。用户可能犹豫是否要重新安排会议,或者可能会认为会议已经安排好了。
  • 不告知用户如何设置日期格式。并非假定用户知道如何设置日期格式,而应表明它需要日期格式 yyyy-mm-dd
  • 不会提供更多帮助。当用户遇到困难且不知道如何继续操作时,可能会停止向 Chat 应用发送消息。

试试看

现在,您已经知道如何编写可操作的错误,接下来确定在以下场景中,哪些错误是可操作的:

当用户向 Chat 应用发送消息包含关键字 schedule 时,Chat 应用就会创建日历活动。如需创建日历活动,Chat 应用需要进行用户身份验证。如果用户未通过身份验证,Chat 应用会返回错误消息。

哪项错误消息可作为操作依据?
你必须先输入“/signin”登录,然后我才能安排会议。如需了解详情,请输入 /help
此错误消息需指明以下信息,因此可以采取措施:
  • 你遇到了什么问题。Chat 应用需要身份验证。
  • 如何继续。输入 /signin 以进行身份验证。
  • 如何获取帮助。如果用户想要了解更多信息,可以输入 /help
您必须通过身份验证。
此错误消息未说明如何进行身份验证,因此无法采取任何措施。
登录。
此错误消息并未说明如何登录,因此无法采取任何措施,因为它没有说明登录方式,而是暗示用户已退出帐号,没有明确说明,这就令人感到困惑。
无法安排会议。
此错误消息无法采取任何措施,因为它没有告诉用户无法安排会议的原因或用户如何继续。未提供任何帮助。