错误消息指南

错误消息是用于描述导致用户或系统无法完成任务的问题的显示文本。 此问题可能会导致数据损坏或丢失。 其他消息类型包括确认、警告和通知。 本主题中的准则旨在帮助你编写易于本地化且对客户有用的清晰错误消息。

编写不当的错误消息可能会导致用户产生受挫感，并且可能会增加技术支持成本。 编写良好的错误消息会向用户提供以下信息：

• 发生了什么，为什么会发生？
• 用户的最终结果是什么？
• 用户可以做些什么来防止这种情况再次发生？

只要开发人员正确处理缓冲区大小，文本长度就不是问题。 用户必须具备解决问题所需的所有信息，这一点很重要。 如果消息具有多个受众，则可能需要为管理员、最终用户和开发人员提供单独的文本。

最佳方案

以下是改进错误消息的方法：

• 避免错误条件。 如果可以预测用户在执行特定操作时将会发生错误，请重写代码，使用户无法导致错误。
• 针对错误的每个已知原因编写单独的错误消息。 请勿使用单个笼统的消息来解释错误的每个可能原因，除非在发生错误时无法确定错误原因。
• 明确说明问题，如果对用户有帮助，请解释导致问题的原因。 尽可能将系统消息表资源中的笼统消息替换为特定于问题的详细消息。
• 向用户提供问题解决方案。 如果解决方案具有多个步骤，请参阅帮助主题，并详细说明任务。
• 仅在消息标题栏中显示产品、组件或向导名称。 这有助于用户确定问题所在位置。 不要在标题栏中总结问题，或包括“错误”一词。
• 请勿使用技术行话，应该使用受众理解的术语。 请勿使用俚语或缩写。
• 使用相应的命令按钮，例如“确定”、“取消”、“是”、“否”和“重试”。 你可以组合使用这些按钮。 “是”和“否”按钮必须始终组合使用，并且前面必须始终有问题。
  • 要停止操作并关闭消息框，请使用取消按钮。
  • 要关闭消息框，请使用关闭按钮。
  • 要提供有关错误原因的详细信息，请使用详细信息按钮。
  • 要提供有关问题解决方案的详细信息，请使用帮助按钮。
  • 如果消息中包含用户操作，请使用确定按钮关闭消息框。
  • 是和否按钮必须组合使用，并且前面必须始终有问题。
• 如果错误是严重错误，请将其写入事件日志。

样式注意事项

• 使用完整但简单的句子。
• 使用现在时来描述导致问题的情况或仍然存在的状态。 可以使用过去时来描述过去发生的不同事件。
• 尽可能使用主动语态。 可以使用被动语态来描述错误情况。
• 避免使用大写文本和感叹号。
• 即使问题是由用户错误造成的，也不要让用户感到自己有错。
• 不要进行人为化。 不要暗示程序或硬件能够思考或者有感知力。
• 不要使用口语单词或短语。 不要使用在某些文化中可能令人反感的词语。
• 不要在未添加介词或从句来阐明含义的情况下复合多个名词。 例如，“站点服务器 LDAP 服务目录服务器”应更改为“站点服务器的 LDAP 服务的目录服务器”。
• 在词语前插入描述符来阐明句子的含义。 例如，“当‘检测’设置为‘否’时指定 InfID。”应更改为“当‘检测’选项设置为‘否’时指定 InfID 参数。”
• 避免使用“错误”一词。 使用更具描述性的词语告诉用户存在的问题。 例如，请避免出现“大小错误”等消息。 而是应告诉用户指定大小时要使用的条件。
• 避免使用“请”字。 这个字可能会被解释为所需操作是可选操作。
• 在索引中放置与消息字符串开头的中心含义相关的字词。