Style Guide
Formatting and style guidelines for Forge product copy
Introduction
This page covers style and formatting for Forge product copy. Consistent structure, usage, capitalization, and punctuation all help create a familiar, focused user experience. It helps answer questions like “What kind of list should I use?” and “Do I need a comma here?” It doesn’t cover our principles, our product personality, or what your copy should say; you can find this information on the Content page.
Key takeaways
- Fundamentals like brand, capitalization, punctuation, and formatting help create familiarity and predictability, so users can keep their focus on what matters.
- UI elements have additional copy guidance that enhances their usability.
- Some usages and terms feel about the same, but it’s worth knowing when to use each one.
- Consult the word list for athenahealth-specific terms.
Fundamentals
Brand
Use lowercase for company and product names, even at the beginning of a sentence. For additional information, visit athenahealth’s brand site.
Company
Use:
- athenahealth to refer to athenahealth employees or the company as a whole: “athenahealth calls payers on your behalf.”
- athenaOne to refer to the application and automated actions: “athenaOne flags claims for followup.”
- athenahealth, Inc. only when referring to the company as a legal entity (for example, in legal documents).
Don’t use:
- athena externally or in product copy. athena is informal and imprecise, so it’s best for internal use only.
- athenaNet. athenaOne replaced athenaNet in July 2022.
- aOne externally or in product copy. Use the full application name athenaOne instead.
Products
Use the full product, service, and feature name:
- athenaCollector, not Collector (and similar for other athenahealth products)
- The Patient Portal, not the portal
- athenaOne Medical Coding, not the medical coding service
Voice and tone
Active voice
Use the active voice for clear, direct product copy that helps users complete tasks. The active voice:
- Makes clear who is performing an action
- Uses a simple structure
- Often uses fewer words
Do this | Not this |
---|---|
“You must attest by December 31, 2022.” | “Attestation must be submitted by December 31, 2022.” |
Customers, clients, users
Customers are organizations and end users who use athenahealth products and services. (Clients is no longer the preferred term.)
Users are individuals who use our products and services. Where possible, use:
- You to address users directly
- More descriptive terms to refer to specific groups of users, like clinicians and staff
We, you
Use we in product copy only:
- When we refers to athenahealth employees performing an action: “We can create a custom interface for your practice.”
- In patient-facing applications like the Patient Portal, where we refers to the practice: “We look forward to seeing you at your appointment on December 3, 2022.”
When addressing users:
- Use you in body text, introductions, and other descriptive copy: “Before you begin, find the 5-digit authorization code. You’ll need to enter this during the certification process.”
- Use the imperative voice to avoid you in instructions: “Enter the patient’s name and address”, not “You need to enter the patient’s name and address”
Pronouns
Instead of defaulting to a gender, use terms that can apply to any gender. When speaking generally, use they for both plural and singular.
Courtesy words
Courtesy words like please, thank you, and sorry can distract users from important information. Use them sparingly.
Do | Don’t |
---|---|
Use courtesy words for serious problems, significant delays and inconveniences:
| Use them for ordinary instructions, short waits, or minor inconveniences:
|
In addition, use thank you when users have done something that benefits athenahealth, such as submitting feedback, a bug report, or data that we requested.
Can, might, may
Use | To indicate | Example |
---|---|---|
Can | Ability | “You can attach additional documentation and resubmit the claim.” |
Might | Possibility | “Patients might prefer to complete the survey online.” |
May | Likelihood | “Patients may be eligible for additional coverage at age 65.” |
May | Permission or authorization | “Approved vendors may attend the event.” |
Capitalization
Forge uses a combination of sentence case and title case, depending on context.
Sentence case
Capitalize the first word and proper nouns: “First and last name”, “Other locations in Massachusetts”
Title case
Capitalize the first and last words. Capitalize all other words except:
- Prepositions such as in, out, of, with, without, about, around, near
- Articles such as a, an, the
- Conjunctions such as and, or, but
For example:
- “Delete Patient Record”
- “Date of Service”
Phrasal verbs
Phrasal verbs consist of two words that are treated as a single unit. When using title case for a phrasal verb, capitalize both words (even though the second word is often a preposition):
- “Log In to athenaOne”
- “Back Up Now”
Other common phrasal verbs that follow this pattern include:
- Check In
- Check Out
- Look Up
- Set Up
- Shut Down
Hyphenated words
When a title includes hyphenated words, capitalize the first and last words. Capitalize additional words, unless they are articles, prepositions, or coordinating conjunctions (and, but, for, or, nor).
- “In-Depth Coverage”
- “Step-by-Step Instructions”
Need help? Try this title case converter.
Exceptions
Some use cases call for a more conversational tone. It’s OK to use sentence case if title case makes the copy look awkward:
- Button copy: “Yes, this is my doctor”, not “Yes, This Is My Doctor”
Acronyms and initialisms
Spell out the full name the first time it appears in body copy, followed by the acronym or initialism in parentheses. Don’t use a period after each letter.
- “One product is an electronic health record (EHR).”
Tall man lettering
Tall man lettering helps users differentiate between drugs that have similar names:
- DOBUTamine, DOPamine
- buPROPion, buSPIRone
- predniSONE, predniSOLONE
Some athenahealth products may use specific formats for medication names. Ask your PO whether this applies to your work.
All caps
Avoid all caps: it’s hard to read and can be interpreted as shouting.
Examples
Element | Case | Example |
---|---|---|
Button | Title case Exception: Sentence case is OK for conversational tone where title case would look awkward | “Save and Add Insurance” Exception example: “Yes, book this appointment” |
Dropdown list item | Sentence case | “Patient’s father” |
Field label | Sentence case | “Last name” |
File extension | Lower case | “.pdf” |
File type | Uppercase | “PDF” |
Headings:
| Title case | “Patient Registration” |
Hint text | Sentence case | “Last name can include spaces, hyphens, and apostrophes” |
Placeholder text | Sentence case | “- Type or select a patient name -” |
Hover text, tooltip text | Sentence case | “Indicates custom settings” |
Icon label | Title case | “Add Note” |
Job title | Lowercase | “nurse practitioner” |
Link | Sentence case | “Learn more” |
Tab labels | Title case | “Provider Info” |
Table:
| Title case | “Task Status” |
Table:
| Sentence case | “Waiting on payer” |
Tags | Title case Note: Tag copy may be displayed in all caps or small caps using CSS, but the copy itself should be in title case, not all caps. | “In Process” |
Punctuation
Period
End all sentences with a period. Use one space (not two) between a period and the next sentence.
Don’t use periods in titles, headings, or subheadings.
Comma
Use the serial or Oxford comma. This means including a comma before and in a list of 3 or more items: “The patient care team consists of doctors, nurses, medical assistants, and other providers.”
In addition:
- Use a comma between a name and degree: “Lesley Clark, MD”
- Use a comma after the date when a date includes the month, date, and year: “January 4, 2023”
- Don’t use a comma between just a month and year: “January 2023”
- Use a comma after e.g. and i.e.: “Use this form to order office supplies (e.g., paper, pens, staplers).”
Ellipsis
Use an ellipsis (…) to indicate:
- Truncated text: “hyperli...” when “hyperlimidemia” is cut off in a small space, like a table cell
- Hidden content: “CT reveals no evidence of dis... (see more)” in a ShowHide
- An incomplete process: “Loading claims...”
To prevent line breaks in the middle of an ellipsis, render it as the single HTML character …
or …
.
Ampersand
Spell out the word and in most instances.
When space is limited, and the two words are conceptually connected, an ampersand (&) can be used instead: “Assessment & Plan”, “A&P”
Exclamation point
Use rarely in UX copy. To convey urgent or important information to users, rely instead on a combination of design elements, like icons, color, alert types, and interruption components.
Lists
Numbered, bulleted
Use a numbered list if the order of the items is important (for example, a prioritized list or step-by-step instructions). Otherwise, use a bulleted list.
Writing lists
- State one idea or data point per list item.
- Use the same structure for all list items:
- Make all list items either phrases or complete sentences.
- Start all list items with same part of speech (nouns, verbs, articles, etc.).
- Use the same tense for any verbs.
- Be concise: short list items are easier to scan.
- Use sentence case.
Punctuation in lists
- Introduce lists with a colon.
- Use periods consistently:
- Use periods if all list items are complete sentences.
- Don’t use periods if all list items are phrases.
- Don’t use commas, semicolons, or conjunctions (and, or) at the end of list items.
Do this | Not this |
---|---|
“Activities of daily living include:
| “Activities of daily living include
|
Formatting
Numbers
Use numerals for all numbers, including those between 1 and 10. Numerals are easier to scan, and they can help make copy shorter.
Exception: It’s OK to spell out one in copy like “Choose one of the following”.
Additional points:
- Use a space between numbers and units: “300 KB”
- Use a comma in any number over 999: “$1,024”
Some athenahealth products use specific number formats for patient safety reasons. Ask your PO whether this applies to your work. For example, some applications might:
- Include leading zeroes: “0.5”, not “.5”
- Exclude trailing zeroes: “10”, not “10.0”
Dates
Forge’s standard date format is MM-DD-YYYY. When a shorter format is necessary due to space constraints, use MM-DD-YY.
When writing out the date in body text, spell out the month when possible. When abbreviations are necessary, use Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec (no period at the end).
Days
Spell out days of the week when possible. When abbreviations are necessary due to space constraints, use Mon, Tue, Wed, Thu, Fri, Sat, Sun (no period at the end).
Time
Forge’s standard time format is HH:MM, followed by AM or PM and the time zone abbreviation: “10:30 AM EST”
Phone numbers
Forge’s phone number format is (###) ###-####.
Medications
For clarity and patient safety reasons, some athenahealth products may use specific formats, like tall man lettering, for medication names. Ask your PO which format your product uses.
Bold
Use bold text sparingly to emphasize key words or phrases:
- A bold word or phrase can help focus users’ attention.
- Bolding an entire sentence reduces readability and is less effective as emphasis.
- Don’t bold whole paragraphs.
Use bold text in specific instructions that refer to UI elements, like buttons or links:
- “2. Enter your password and click Log In.”
Don’t use bold text for UI elements in descriptive or conceptual body text:
- “The Insurances section displays information about the patient’s primary and supplemental insurance policies, including prescription drug coverage and insurance card images. Verify all information with patients when they check in.”
Bold text should be the same color as the surrounding regular text. Don’t use a different color for additional emphasis, because different color text often indicates a link.
Italic
Use italic text only to introduce new terms (usually followed by a definition or explanation in regular text). Italic text can be hard to read, so use it sparingly.
Product and UI
The fundamentals apply broadly to interface copy, but some UI elements have additional guidelines that help create a consistent user experience across products.