Rules for User Interfaces

From Scantegrity Wiki

User interfaces are important. These rules are meant to create a consistent look and feel, and to make the software as clear and as easy to use as possible.

Contents 1 Internationalization 2 Buttons 3 Instructions 4 Menu Options 5 Error Messages

[edit] Internationalization

All text and images should be given a unique, identifiable name and added to the internationalization library in the repository. Your UI should call to add your text or images using the internationalization library.

[edit] Buttons

All buttons should perform an action, and should be verbs, if possible. Some examples: Save, Cancel, Delete, Add, Block. Some bad examples: Okay, Done, Yes, No.

[edit] Instructions

Instructions should always be given in the active voice. When necessary, a link or reference to more detailed instructions should be provided.

[edit] Menu Options

Menu options should always have shortcuts. If the actions are similar to another application, the shortcuts should match that application on the Windows platform.

[edit] Error Messages

Error messages should start with the general description of what was wrong, and continue with an explanation of the possible (known) causes of the problem. If necessary, a "get more info" button should be provided, but this is discouraged.

Error messages should be passive. They should not pop up and interrupt the user, but should appear at a designated spot in the user interface. If the user does a direct action to cause an error, the error should occur and allow the user to retry their action.