撰写切实可行的错误消息

本页介绍了编写实用的错误消息的最佳实践，这些消息会告知用户如何解决问题，以便用户能够实现自己的目标。

当用户与 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 应用会返回一条错误消息。