Ten Ways to Improve Your UI Text (Windows Embedded CE 6.0)

1/5/2010

The following list shows techniques that you can use to improve the text in your user interface:

1. Make every effort to explain concepts.
   Good UI text clearly explains all of the concepts that might be unfamiliar to new users and tells users how to perform the tasks presented. For example, Instead of saying that a Bluetooth device is discoverable, use the term available.
2. Use one term for all concepts that have the same meaning.
   To find out if there is a preferred term for a concept, check the Microsoft Manual of Style for Technical Publications (MSTP) and products similar to yours. If there is no preferred term, work with your UI text writer to select or create a term, and then use that term consistently throughout the UI.
3. Do not use negative or politically sensitive terms, such as abort, or invalid.
4. Write active sentences.
   In an active sentence, the subject carries out the action. In a passive sentence, the subject receives the action. Avoid passive construction except when it is necessary to avoid placing blame on a user.
   The following is an example of an active sentence:
   Enter a name.
   The following is an example of a passive sentence:
   A name must be entered.
5. Present the result before the required action when writing instructional text.
   To prevent users from performing actions before they understand the consequences, explain the outcomes before you tell them the actions.
   The following is a correct example:
   To add a new contact, click New.
   The following is an incorrect example:
   Click New to add a new contact.
6. Leave enough space for localization.
   Translated text strings can expand more than 30 percent. Be sure there is enough room in your UI to accommodate this expansion.
7. Follow consistent capitalization and punctuation guidelines.
8. Write informative error messages.
   An informative error message tells users what happened, why it happened, and how to fix the problem.
9. Use acronyms.
   Use acronyms in the UI and Help to conserve screen space. Submit the acronym and its spelled out form to your documentation writer, so this information can be included in a glossary for reference.
10. Do not use technical jargon.
    Use terminology that your audience understands. Avoid unnecessary technical terminology and sentences. Do not use slang. Some examples of technical terms and slang are: activate, screen real estate, modify, software-based input panel (SIP), reboot, and power up/down.

See Also

Concepts

User Interface Design Guidelines
User Interface Customization for a Networked Media Device