Writing Interface Content
In addition to all the body content on our site, we also use a number of specialized content types in our interfaces.
All other guidelines for good content still apply, but here's what else you need to know about writing interface content and microcopy.
USER INTERFACE COPY
User Interface (UI) copy is a short piece of text that can include any of the following:
- Buttons or calls to action
- Form labels
- Inline help text
- Navigation
- Tool tips
UI copy should convey what's expected of the user and what will happen when they take an action. To achieve this:
- Be brief. Don't say, "Please provide your first name" when "First name" will do.
- Be specific. A button labeled "Clear" means something very different than a button labeled "Cancel." Choose wisely.
- Be consistent. Before you add anything new, check for existing conventions elsewhere on our website.
Above all, remember: Text can't fix a bad interface. Most users won't read it. If more than a phrase or brief sentence is required to explain how or why a user should complete an action, the UI needs more work.
ALERTS AND ERROR MESSAGES
Alerts are usually triggered when something goes wrong, or when we we're trying to communicate important information in context.
These messages often sound inhuman or jargony, but they don't have to. Just a few simple guidelines lead to better alerts:
- Plan ahead. Anticipate cases that trigger the alert. Adjust your tone and the information you provide according to the situation.
- Offer help. Always provide a plain-language description of what happened and let the user know how they can correct it.
- Be calm. Don't use exclamation points or alarming words like "alert" or "immediately."
INCORRECT
Alert: An error has occurred! Please contact your administrator!
(Ref: 171)
Correct
Sorry, we're having trouble retrieving your account information right now. Please try again in a few minutes. If the problem persists, report it to us.
TRANSACTIONAL EMAILS
Transactional emails are generated automatically when a user completes an action. For example: a confirmation message when they submit a form or pay a bill. Like alerts and error messages, it's all too easy for this content to sound inhuman or awkward.
- Write a clear subject line and keep body content brief.
- Clearly outline any action a user must take.
- If HTML formatting is an option, use it instead of plain text.
- When possible, emails should be sent from a monitored email address, like a shared inbox for your office. If the email must come from an unmonitored address, let the user know not to reply and be sure to provide another means of contact.
EXAMPLE
Your Animal License Expires Soon
This is a reminder that your Baltimore County animal license expires June 30. The annual renewal period will open on May 1, at which time you'll receive an email with complete details. You don't have to take any action yet.
This is an automatically generated email. Please don't reply.
FORM INPUT VALIDATION
Error messages for required form fields should be concise and actionable. Speak directly to the user and make sure to describe any format requirements in plain language.
For consistency, use the following error messages for common field types.
First Name | Enter your first name. |
---|---|
Last Name | Enter your last name. |
Enter a valid email address. | |
ZIP Code | Enter your five-digit ZIP code. |
Phone | Enter your phone number, formatted as xxx-xxx-xxxx. |