Examples of Errors in Sentences: Common Pitfalls in UX Writing

When it comes to UX writing, technical documentation, and technical marketing, precision is key. Even small errors in sentences can lead to confusion, user frustration, or even loss of credibility. Let’s explore common sentence-level errors in these fields and how they can impact the user experience.

1. Overly Technical Jargon

• Error: “To access the system, invoke the designated protocol using the assigned IP address and authenticate via your credentials.”
• Better: “To log in, use your username and password.”

Explanation: Overly technical jargon alienates users who may not be familiar with specialized terms. UX writing should simplify and clarify, using language that is accessible to all users.

2. Ambiguity in Instructions

• Error: “Click the icon to reset.”
• Better: “Click the reset icon to restore your settings to default.”

Explanation: The original sentence is unclear—what does "reset" mean? Reset what? Providing clarity ensures that the user understands exactly what action they are taking and its consequences.

3. Inconsistent Terminology

• Error: “Press the button to submit your form, then hit enter to confirm the input.”
• Better: “Click the ‘Submit’ button to send your form.”

Explanation: Using different terms for the same action (e.g., “press,” “hit,” “submit”) creates confusion. Consistency in terminology is crucial for technical documentation and UX writing to provide a seamless user experience.

4. Unnecessary Passive Voice

• Error: “The update was performed by the system automatically.”
• Better: “The system automatically updates itself.”

Explanation: Passive voice can make sentences cumbersome and harder to follow. Active voice is more direct and easier to understand, which is critical in technical writing where clarity is essential.

5. Vague Error Messages

• Error: “An error occurred. Please try again.”
• Better: “Connection failed. Check your internet connection and try again.”

Explanation: Error messages should provide specific information about what went wrong and how the user can fix it. Vague messages leave users confused and unsure about the next steps.

6. Redundant Information

• Error: “For additional help, consult the help manual or contact customer support for more assistance.”
• Better: “Consult the manual or contact support for help.”

Explanation: Redundancies clutter the text and make it harder to read. Avoid repeating information unless necessary.

7. Missing Articles

• Error: “Go to settings and change language.”
• Better: “Go to the settings and change the language.”

Explanation: Missing articles like “the” or “a” can make the sentence feel incomplete or awkward. In technical documentation, details matter, and grammatical errors like this can affect readability.

8. Unclear Pronoun Reference

• Error: “Select the software and install it on your system. After it completes, reboot.”
• Better: “Select the software and install it on your system. After the installation completes, reboot your computer.”

Explanation: The pronoun "it" in the original sentence is unclear. Does it refer to the software, the system, or the installation process? In technical writing, unclear pronoun references can confuse the reader.

9. Too Many Steps in One Sentence

• Error: “After logging in, selecting your preferences, and adjusting the settings, click on the confirmation button to proceed.”
• Better: “Log in. Select your preferences and adjust the settings. Then, click the confirmation button to proceed.”

Explanation: Too many actions crammed into one sentence can overwhelm the reader. Breaking down the steps into multiple sentences helps users follow along easily.

10. Overloaded Sentences

• Error: “The platform offers users a customizable dashboard with real-time analytics, adjustable widgets, and seamless integration with third-party apps, and users can export reports in various formats as well.”
• Better: “The platform allows you to customize your dashboard, view real-time analytics, and integrate with third-party apps. You can also export reports in various formats.”

Explanation: Overloaded sentences with too much information are hard to process. Separating ideas into multiple, simpler sentences improves readability and understanding.

11. Inconsistent Voice and Tone

• Error: “The file has been successfully uploaded. Great job! Now, proceed to the next step by clicking here.”
• Better: “Your file has been uploaded. Click ‘Next’ to proceed.”

Explanation: In technical documentation, it’s important to maintain a consistent tone. Shifting from formal to informal (“Great job!”) can confuse users. Keep a professional and neutral tone throughout.

12. Missing Context in Calls to Action

• Error: “Click here to learn more.”
• Better: “Click here to learn more about setting up your profile.”

Explanation: Without context, users don’t know what they’re clicking on or why they should care. Be specific in calls to action to give users a clear understanding of the result.

13. Incorrect Pluralization

• Error: “Update all software’s on your system.”
• Better: “Update all software on your system.”

Explanation: “Software” is a non-count noun and doesn’t take a plural form. Grammar errors like this can hurt credibility in technical writing, so attention to detail is crucial.

14. Overuse of Abbreviations

• Error: “Once you have access to the API, check the EOD for results.”
• Better: “Once you have access to the application programming interface (API), check the end of day (EOD) report for results.”

Explanation: While abbreviations and acronyms can be useful, overusing them without explaining their meaning can confuse readers, especially those unfamiliar with industry terms. Define acronyms on first use.

UX Writing Errors & Wins

In UX writing, technical documentation, and technical marketing, precision and clarity are paramount. Errors like jargon, vague instructions, inconsistent terminology, and missing context can significantly impact user experience and understanding. By focusing on clear, concise, and user-friendly language, technical writers can avoid these common pitfalls and create more effective documentation. Attention to detail in these areas ensures users can successfully engage with products and services, leading to a smoother overall experience.