Home
Messages - Do you know how to put the technical info? (2/3 Description)
  v1.0 Posted at 27/11/2012 3:37 PM by Rebecca Liu

Description

The description should explain what the error was, followed by the why it occurred. Information that is useful for debugging should be included with errors where possible in a "Details" section. You should also avoid making the text unnecessarily wide. e.g.
Centrix - Invalid Quote
Figure: Bad Example - A message box that does not intuitively alert the user
  • This is confusing, because it uses different terminology to the title ("estimate" instead of "quote")
  • There is no punctuation
  • The word "Error" is meaningless
  • Line breaks are not present, so the message box is too wide and the text may wrap in the wrong spot
Centrix - Invalid Quote Details
Figure: Good Example - A message box that is clear, consistent and intuitive
  • Terminology is consistent
  • Punctuation is present
  • "Details" indicates that this information is useful for debugging
  • The text is split across three lines, and the technical information after Details is separated from the description of the error

Related rules

    Do you feel this rule needs an update?

    If you want to be notified when this rule is updated, please enter your email address:

    Comments:

    Note: Social Media login for Yotpo is not working in IE or Safari, please use Chrome. We are waiting for Yotpo to fix it.