本页介绍了编写实用错误消息的最佳实践,这些消息可告知用户如何解决问题,以便他们完成目标。
当用户与 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 应用发送消息。
试试看
现在,您已经知道如何编写可操作的错误了,您能否在以下场景中找出哪些错误是可操作的:
当用户使用关键字 schedule
向 Chat 应用发送消息时,Chat 应用会创建日历活动。如需创建日历活动,Chat 应用需要用户进行身份验证。如果用户尚未通过身份验证,Chat 应用会返回错误消息。
/signin
登录,然后我才能安排会议。如需了解详情,请输入 /help
。- 出什么问题了。Chat 应用需要进行身份验证。
- 后续步骤。输入
/signin
进行身份验证。 - 如何获取帮助。如果用户想要了解更多信息,可以输入
/help
。