While browsing I bumped into an article in MSDN Magazine that preached what the error messages are all about. Here is the summary:
The characteristics of good error messages
- A problem. States that a problem occurred.
- A cause. Explains why the problem occurred.
- A solution. Provides a solution so that users can fix the problem.
Additionally, good error messages are presented in a way that is:
- Relevant. The message presents a problem that users care about.
- Actionable. Users should either perform an action or change their behavior as the result of the message.
- User-centered. The message describes the problem in terms of target user actions or goals, not in terms of what the code is unhappy with.
- Brief. The message is as short as possible, but no shorter.
- Clear. The message uses plain language so that the target users can easily understand problem and solution.
- Specific. The message describes the problem using specific language, giving specific names, locations, and values of the objects involved.
- Courteous. Users shouldn't be blamed or made to feel stupid.
- Rare. Displayed infrequently. Frequently displayed error messages are a sign of bad design.
No comments:
Post a Comment