哪种消息队列更好_如何编写更好的错误消息

哪种消息队列更好

用户第一次遇到应用程序的文档时，并不总是带有用户手册或在线帮助。 通常，与文档的第一次相遇是一条错误消息。

技术作家应参与编写错误消息。 这是工作的重要组成部分，尽管经常被忽略。 毕竟，错误消息是文档，尽管文档中嵌入了文档。

您问，为什么技术作家要参与创建错误消息？ 许多错误消息不能很好地帮助用户。 实际上，他们经常像机器为机器所写那样阅读。 您遇到过几次错误消息，例如“ 发生意外错误”或（我多年以来最喜欢的）“ 对象引用未设置为对象的实例 ？”。 像我一样，当您看到类似这样的错误消息时，您可能会挠头。

但是，编写错误消息并不像听起来那样简单。 我想分享一种我多年来使用和改进的技术来编写有效的错误消息。

良好错误消息的要素

错误消息应该有意义。 我的意思是，不仅对于开发人员，而且对于软件用户都具有充分的意义。 为避免出现任何恐慌或混乱，该消息应清晰。

错误消息应该有意义。

有意义的错误消息应：

• 简短（可以写成片段）；
• 用简单的语言描述出了什么问题; 和
• 使用不会（无论是否明确）责怪用户的措辞或语气。

该消息还可以包含错误代码或用户可以发送给支持的日志或错误文件的位置。 您还可以包括一个指向文档或任何故障排除信息的链接。

假设您正在编写错误消息，提示无法打印文档。 消息“ 打印失败”没有那么有意义。 而是，该错误消息可能显示为：

• “我无法打印您的文档。请检查您的打印机或连接。”
• “打印失败。请检查您的打印机。”
• “无法打印文件。请检查打印机或参阅故障排除文档。”
• “文件未打印。您的打印机电源打开了吗？”

创建有效的错误消息

我教过我的技术，可以为同事编写更好的错误消息，他们发现它很有用。 我想你也会。

如果您需要重写现有的错误消息，请将当前文本写在便笺上，然后将其打在显示器的右上角。 或者，如果您正在编写新消息，请与开发人员或质量保证人员联系以获取有关错误原因的详细信息。 将关键点写在便签上，然后将其拍在显示器上。 无论哪种方式，便笺都会作为提示出现。

接下来，启动一个文本编辑器或抓住笔和纸，然后开始书写。 目的是让思想和言语从大脑中流出。 不必担心您所写的内容是否有用。 为什么？ 大部分结果都不会很好。 大多数将无法使用。 您可以稍后消除谷壳。 尝试为该消息提出4到10种变化； 越多越好。

总是以对话的语气写错误信息，但不要太可爱或风趣。

总是以对话的语气写错误信息，但不要太可爱或风趣。 尽管类似“我的打印机，我的打印机之间出了点问题。最好检查一下是否一切正常”这样的错误消息很容易阅读，但是它太长了，而且还没有足够快地解决问题。

修剪，修剪，修剪

拥有清单后，将其缩减为两种至五种可能性。 然后，将这些可能性发送给您的团队。 这通常导致达成共识，赞成一点点的案文。 通常但并非总是如此。 如果没有达成共识，请尝试合并几个最受欢迎的选择，以获得可接受的替代方案。

使用这种技术的关键是不要挂在所有想法的质量上。 您只需要让单词流动，然后编辑并调整最终错误消息，直到可以使用为止即可。

翻译自: https://opensource.com/article/17/8/write-effective-error-messages

哪种消息队列更好