PatternFly

UX writing best practices

Treat words as part of your design, not something to be added at the end. UX copy needs to be rooted in user information and context so that it can contribute to an effective, intuitive, and human-centric product experience.

By making writing part of your design process, you’ll also be able to uncover design issues at the very beginning. If a design is too difficult to explain with words, then it might still need some work. By the time you create high-fidelity mockups, you’ll already have a few rounds of content feedback under your belt and can focus on refinement. Work across teams to fine-tune your copy and align your words with voice and tone standards.

This guide details the best practices that you should follow when writing for UX.

Know your users

Before you write, understand who you're writing for. Getting to know your users’ needs and experiences can inform you on what words will resonate with them.

To understand your users, create user personas (or use the ones your team already has) and reference them as you work. If your team is in the process of gathering information about users, there are a few ways you can get involved:

  • Ask to sit in on any interviews and listen.
  • Make notes about specific words being used, standards being referenced, or concepts that keep coming up.
  • Do your own research into your users’ domain by reading popular blogs, forums, or documentation.

Focus on goals and tasks

Consider what your user is trying to accomplish (the goal) and the steps they’ll take to get there (the tasks). By understanding the entire user journey, you can provide the right content to the right user in the right place at the right time.

Frame each task as a conversation. Imagine you are sitting in a room with your user, and write out the conversation you might have to help them accomplish their task. This activity can help you:

  • Write in a natural and conversational way, which can inform and improve the content you use in the interface.
  • Anticipate questions the user might have along the way.
  • Anticipate information you need to collect from your user.
  • Identify gaps in your knowledge or understanding.

Understand the context

Users carry around a lot of baggage, so it’s important to know where they’re coming from—literally, personally, and emotionally.

  • Literally: Take a look at the application or feature you’re building and figure out the potential paths your user could have taken to arrive in this spot. Are they coming from a Google search? Another page in the application? An email?

    Use that context to plan for the information they need to see in order to get themselves oriented. This might mean you should create a strong header with some intro text, a clear call to action, a breadcrumb bar, or all of the above.

  • Personally: Consider where the user is coming from personally. What terminology are they expecting to see? Will they be familiar with all the information you’re giving them? Is it possible they might need additional information or links to documentation?

    Use that context to choose the right terminology and prioritize your content.

  • Emotionally: Consider how your user is likely to be feeling in the situation you’re designing for. Is this situation stressful (paying a bill)? Frustrating (account creation error)?

    Empathize with them, and be sure to use an appropriate tone.

Sound like a person

Jargon, bizpeak, and formal language make you sound more like a brochure than a human. Users need to relate to your brand and like you before they can trust you. Talk with them as people using familiar, conversational words.

Before
After
Utilizing the open source phenomenon allows you to leverage collaborative communications.
Open source is great for collaboration.

Be clear and concise

Dr. Seuss said it best: “So the writer who breeds more words than he needs, is making a chore for the reader who reads.” Use plain language, and don’t use more words than you need. Chunk content into short, related sections, and avoid long paragraphs or strings of text.

Before
After
Make the decision to send a notification to your administrator.
Notify your administrator.

Be consistent

Stick with the same terminology to describe actions and objects across the entire user experience. Using two terms interchangeably—even when they mean the same thing—can confuse users.

Before
After
Log in to your account only. Never sign in to your friend’s account.
Log in to your account only. Never log in to your friend’s account.

Align with your brand

Make sure your UX copy reflects your brand voice (as we outline in our brand voice and tone guide). UX copy is not just for adding clarity and guiding users through the interface. You’re also creating an experience with your words, making a product interaction sound, feel, and look like a human conversation.

Lead with the benefit

Users want to know why they should do something. What’s in it for them? They typically focus on the beginning of a sentence, so make your instruction worth it by starting with the outcome—in other words, the benefit.

Before
After
Install this extension to learn more about email.
To learn more about email, install this extension.

Use positive, action-oriented language

Focus on what the user needs to do in order to complete the task or reach their goal. Give directions that show users that they can do what they're hoping to.

Before
After
Your user settings do not allow you to access this file.
To access this file, adjust your user settings.

View source on GitHub