撰写切实可行的错误消息

这一页介绍编写可操作性错误消息的最佳实践, 用户该如何解决问题,从而实现自己的目标。

当用户与 Google Chat 应用互动时,会遇到 错误消息无法解决时可能会令人沮丧。 例如,错误消息An error occurred就没用了,因为 消息没有说明问题所在、用户该如何解决问题 用户是否可以获得帮助本页面介绍了如何设计错误消息结构, 可以展示切实可行的示例,让用户知道这些信息对用户有用。

错误消息结构

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

  • 出了什么问题。说明 Chat 应用无法运行的原因 完成请求有助于用户解决问题。解释错误的原因 建立信任。
  • 用户如何才能达成目标?只将 告诉你哪里出了问题。告诉用户如何才能越过错误并完成 自己的目标
  • 如何获取帮助。如果用户仍遇到困难,请告知他们该如何操作 更多帮助。这可能是 /help 命令或指向相关文档的链接 。

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

在此示例中,用户以 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
此错误消息是可行的,因为它包含以下信息: <ph type="x-smartling-placeholder">
    </ph>
  • 哪里出错了。Chat 应用需要使用 身份验证。
  • 如何继续操作。输入 /signin 进行身份验证。
  • 如何获取帮助。如果用户想要了解更多信息,可以输入 /help
您必须进行身份验证。
此错误消息没有说明如何 身份验证。
登录。
此错误消息没有说明如何登录,因此无法采取任何措施 表明用户已退出登录,而不是 让人感到困惑
无法安排会议。
此错误消息并未告知用户,因此无法采取措施。 为什么无法安排会议或用户如何继续操作。无帮助 。