谷歌技术文档写作课程笔记 12 如何写错误提示

Posted by Shiwei Shang on June 27, 2025

如何写错误提示

一个好的错误提示包含三部分信息:

  • 指出错误。首先要告诉用户错误是什么,哪里出现了问题。
  • 说明原因。然后告诉用户为什么出错了,是输入错误还是输入的东西不符合要求,正确的输入的格式是什么。
  • 提供办法。最后告诉用户怎么做,可以提供正确的示例。

错误信息的语言同样要求明确,要做到:

  • 简练
  • 避免双重否定
  • 分析受众并提供适合他们的信息。用户是技术人员,信息可以写得技术一点,如果是普通用户,信息要写得白话一点。
  • 保持术语一致
  • 采用易读的版式
  • 采用正向、礼貌但不卑不亢的口吻,不要责备,避免幽默