知识卡片
错误信息可诊断
内容
错误信息既要帮助用户采取下一步行动,也要给支持和开发人员提供定位线索。日志、错误码和上下文信息应互相配合。发散:好的错误信息不是道歉,而是一次小型故障报告。
参考来源
- 位置:第7章《敏捷调试》"37 提供有用的错误信息"(源文件:_epub-src/OEBPS/text00000.html)
- 结论依据:原文明确"类似'出错了'这样的消息,无法帮助团队针对问题做出诊断",提出用带超链接的错误信息同时满足用户理解和开发者调试两个目的,并将错误分为程序缺陷、环境问题、用户错误三类分别给出不同建议,直接支持卡片结论。
- 原始内容:"类似'出错了'这样的消息,无法帮助团队针对问题做出诊断。……一方面要提供给用户清晰、易于理解的问题描述和解释,使他们有可能寻求变通之法。另一方面,还要提供具备关于错误的详细技术细节给用户,这样方便开发人员寻找代码中真正的问题所在。……展示有用的错误信息。提供更易于查找错误细节的方式。……程序缺陷……环境问题……用户错误……通过追踪记录报告的错误类型,可以为受众提供更加合适的建议。"