Language:Warnings

From KDE-HIG_Wiki

Four rules of messages

Warning and error messages should be:

  1. understandable
    Phrase your messages clearly and in non-technical terms and avoid obscure error codes. Only include error codes when it is necessary and possible for any support personnel to track down and solve this specific error. In this case, write a regular non-technical error message and add the error code below it. The code shouldn't be necessary for understanding the error, however. Also include a hint for the user what to do with the code, e.g. "You may report the following code to support personnel so they can solve the problem more quickly." <todo>examples for understandable/non-understandable messages</todo>
  2. specific instead of general
    If the message is reporting a problem concerning a specific file/document or application, use the file or application name when refering to it. Example: Instead of saying "Can't open file because application is not installed", say "Can't open Report.kwd because KWord is not installed.
  3. constructive -- help users solve the problem <todo>explain, examples</todo>
  4. polite and non-blaming
    (avoid "illegal", "fatal" etc.; no uppercase; <todo>explain; good examples: bash says "Sorry." when you try to login with a wrong password; Kopete: "Kopete is unable to save your Password in your wallet."</todo> )

other good ideas

  • "details" button -- only a short error message and a button that provides more a detailed explanation in the same error dialog <todo>add screenshot from kde app that does this</todo>
  • if it makes sense for this kind of error, link from the error dialog to the corresponding page in the help system

Button labels in message dialogs

if the user has to select an option to proceed: button labels should describe the actions instead of saying 'yes' or 'no' (e.g. 'Delete file' 'Don't delete file')