撰写切实可行的错误消息

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

当用户与 Google Chat 应用互动时，如果错误消息不可操作，用户体验会非常糟糕。例如，错误消息 An error occurred 就没什么用，因为该消息没有说明出了什么问题、用户如何解决问题或用户如何获得帮助。本页面介绍了如何构建错误消息，以便通过显示可操作和不可操作的示例来帮助用户。

错误消息结构

可操作的错误消息具有以下结构：

• 出了什么问题。说明聊天应用无法完成请求的原因有助于用户解决问题。说明发生错误的原因有助于建立信任。
• 用户如何朝着目标迈进。仅仅说明出了什么问题是不够的。告知用户如何解决此错误并完成目标。
• 如何获取帮助。如果用户仍然卡在这一步，请告知他们如何获取更多帮助。这可以是 /help 命令，也可以是指向 Chat 应用文档的链接。

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

在此示例中，用户输入的日期格式与 Chat 应用预期的格式不符。他们写的是 November 19, 2021，但 Chat 应用需要的是 2021-11-19。

以下是 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 应用安排与另一人的会议。聊天应用会返回一条无用且无法采取行动的错误消息：

Enter the correct date format.

此错误消息无法采取任何措施，原因如下：

• 未说明是否已安排会议。用户可能不愿重新安排会议，或者可能认为会议已安排妥当。
• 未告知用户如何设置日期格式。不应假设用户知道如何设置日期格式，而应说明系统需要 yyyy-mm-dd 日期格式。
• 不提供更多帮助。当用户遇到困难且不知道如何继续时，可能会停止向 Chat 应用发送消息。

试试看

现在您已经了解如何编写可操作的错误，那么在以下场景中，您能否找出哪些错误是可操作的：

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