Checklist for good UX writing
Create an information hierarchy
Section titled “ Create an information hierarchy”- Does the headline clearly communicate the primary focus for the user on this screen?
- Does the call-to-action (CTA) match or follow logically from the headline?
- Does the subheader provide an explanation or more information about the headline? A common pattern is that the headline says “Here’s what you have to do” and the subheader succinctly explains why.
- Is the info presented in the best format for this content?
- Can this info be presented as bullet points? What about as a full sentence? Try several formats and compare—which sounds most natural?
Select the appropriate tone
Section titled “ Select the appropriate tone”What might the user be feeling at this moment? Is the tone of this message suitable for the situation?
Common scenarios and the right tones for them:
- Introductory, success, or confirmation screens
- Tone: Friendly, playful, warm, or encouraging
- FYI communications
- Tone: Informative, natural but not cutesy, potentially urgent
- Unexpected complications
- Tone: Explanatory but not apologetic
- Errors Certara caused
- Tone: Apologetic, informative, potentially urgent
Do the work to make it simple
Section titled “ Do the work to make it simple”The classic anecdote about a writer’s apology to his friend perfectly captures the essence of concise writing: “I’m sorry I wrote you such a long letter—I didn’t have time to write a short one.”
- Look at each sentence/snippet on your screen. What is the core message of each? Is there any repetition?
- Is there any technical or specialized language in this text? Can it be broken down into simpler terms for better understanding?
- Could you remove any redundant words?
- Is the sentence structure as simple as possible? If the sentence is long, could it be broken into two simpler sentences? For help, check out the Hemingway app
. - Is it clear to the reader who’s performing what action? Does it have a clear subject and action?
Make it inclusive
Section titled “ Make it inclusive”- Are there sayings, unusual phrases, or age-specific slang you could remove?
- Before: That was a piece of cake
- After: That was easy
- Are the actions accessible?
- Before: Click on the menu on the left-hand side of the screen
- After: Select the “Getting started” menu
- Could a middle-school reader understand this? Are there long or complex words that have a simpler alternative? Check the level of your writing
. If it’s above 7th-8th grade, see “Do the work to make it simple.” - Before: Effective January 1
- After: Starting January 1
Follow these tips for clear writing
Section titled “ Follow these tips for clear writing”Five great guidelines for clear, concise writing, courtesy of George Orwell:
- Don’t use a metaphor, simile, or other figures of speech that you commonly see.
- Don’t use a long word if a shorter one will do.
- If you can omit a word, do it.
- Use active voice.
- Don’t use foreign phrases, scientific nomenclature, or jargon if there’s an everyday word you can use instead.