Mechanics for UI Text

BETA
Decorative background image
Foundations / Writing and Wording / UX Writing / UX Writing Guidelines / Mechanics of UI Text
information
This guideline is currently in beta. After consolidation and enhancements, it will replace the UI Text Guidelines for SAP Fiori Apps. Until then, the existing guideline remains available.

Intro

The mechanics of UX writing define how we apply our voice in practice. They turn principles into repeatable decisions that scale across products, teams, and languages.

Clear mechanics support all three strategic priorities:

These guidelines are not stylistic preferences. They are standards designed to help users move confidently through complex processes.

Terminology and Standard Formulations (UXC-015)

Use the same term for the same concept everywhere.

Consistent terminology helps users build a stable mental model of the product and prevents misunderstandings, especially in complex workflows. It also enables AI systems and translation tools to interpret UI text reliably.

When terminology is consistent, users don’t have to stop and ask, “Is this the same thing as before?”

Refer to the product standard requirements, which contain a list of standard terms.

Readability and Clarity

UI text should be understood at a glance.

Professionals using SAP products make high-stakes decisions under time pressure. Our writing respects that reality by being direct, precise, and easy to scan.

To improve readability and clarity:

Examples

Do

Choose Prepare Billing.

Don't

Next, choose Prepare Billing once it becomes active.

To avoid performance problems during working hours, schedule the route generation as a batch job.
Schedule the route generation as a batch job. This avoids performance problems during working hours.
After creating the account, confirm the account by entering the authentication code.
Enter the authentication code after creating the account.

English

U.S. English is the source language for SAP product content.

Using a single, consistent source language ensures clarity for a global audience and supports accurate translation.

Key guidelines:

information
Exception: In legal, financial, HR, or region-specific contexts, follow applicable local standards instead of U.S. English.

Examples: Spelling

U.S. English
U.K. English
Color
Colour
Organize/Organization
Organize/Organization
Center
Centre
Gray
Grey
Canceled/Canceling
Cancelled/Cancelling

Present Tense

Use present tense by default.

Present tense reflects what is happening now or what generally happens in the system. It keeps instructions immediate and easy to process.

Examples

Do

After you’ve submitted the request, your new balance appears.

The account assignment category determines how the system assigns accounts.

Your settings are applied when you restart.

Extract the archive and make a note of the location. You'll use the extracted files in a later step.

Don't

After submitting the request, your account balance will appear.

Second Person

Address users directly.

Use “you” and “your” to create a clear, conversational, and people-centric experience. Direct address keeps the focus on the user’s current task and eliminates unnecessary distance.

Examples

Do

You have new messages.

The connection can't be established. Please contact your administrator.

Upload your data file.

Don't

New messages are available in your inbox.

The application was not able to reestablish the connection with your service.

Abbreviations and Acronyms

Avoid abbreviations and acronyms in UI text whenever possible.

Abbreviations reduce readability, create ambiguity, and often fail in translation due to lack of context. Because UI text is typically consumed in short, fragmented segments, clarity must come first.

Use abbreviations only when they are:

If an abbreviation is necessary, introduce the full term nearby, ideally in a heading or subheader.

Examples

Do

Pay Results for Statutory Sick Pay (SSP) {as a subheader on a page}

ID (instead of identifier)

ABAP (instead of Advanced Business Application Programming)

API (instead of Application Programming Interface)

Don't

Proj. Fcst. instead of Project Forecast

Capitalization and Punctuation

Proper punctuation supports comprehension.

Follow standard U.S. English punctuation rules as defined in The Chicago Manual of Style, unless UI constraints require deviation. If you diverge, do so intentionally and consistently.

For more information about punctuation marks and special characters, refer to - SAP Style Guide for Technical Communication: Punctuation Marks and Special Characters on the User Interface.

information
Remember that SAP uses the serial (Oxford) comma.

Do

Create, edit, and delete records.

Don't

Create, edit and delete records

Title Case vs. Sentence Case

Capitalization communicates structure and hierarchy.

This distinction improves scannability and reduces visual noise.

Title case examples

Sentence case examples

When in doubt, default to sentence case for readability.

Numbers and Numerals

Prefer numerals in UI text.

Space is limited on interfaces, especially on mobile devices. Numerals are faster to scan and easier to interpret.

The format of the number depends on the data type of the field, how long it is, and the locale you’re writing for.

For more information, refer to the UI Text Guidelines for Formatting Data.

Examples

Do

Position is understaffed ‎(1 of 3 FTE)‎.

My Requests for Approval (5)

We detected five unsuccessful sign-in attempts. If this wasn’t you, reset your password immediately.

You have saved drafts from three different devices. Review them before syncing.

Don't

Position is understaffed (one of three FTE).

My Requests for Approval (Five)

1 or more devices stopped syncing. Sync them manually before continuing.

Component-Specific Guidance

Component‑specific guidance explains how the SAP product voice is applied in recurring UI patterns. These patterns appear across products, teams, and experiences. Writing them consistently helps users recognize what’s happening, understand what’s required, and move forward with confidence.

This section focuses on messages, one of the most critical interaction points in the user experience.

Messages

Messages communicate system states, outcomes, and required actions. They appear at moments when users need clarity most. For example, while making decisions, resolving issues, or confirming important actions.

Well-written messages do three things:

  1. Explain what’s happening
  2. Clarify why it matters
  3. Indicate what happens next (or what the user should do)

When messages are clear and predictable, users trust the system more and recover from issues faster.

Message Structure

Messages are typically presented in a message box with three parts:

Each part should earn its place. If information doesn’t help the user decide or act, remove it. For more information, see Message Box Anatomy.

Message Types

SAP uses five standard message types. Each type signals urgency and intent through both design and language.

Always choose the weakest message type that still communicates risk or importance. Overusing errors or warnings reduces their effectiveness.

Writing Effective Message Text

Messages appear at moments of heightened attention. Users may be under time pressure, resolving errors, or confirming critical actions. As a result, message text must be especially clear, restrained, and purposeful.

When writing message content:

For more information, refer to UI Text Guidelines for SAP Fiori Apps - Messages.

Message Titles

Message boxes include default titles that reflect the message type, for example, Error, Warning, or Success. In most cases, these defaults are sufficient and should be left unchanged.

Replace a default title only when a more specific title improves clarity or decision‑making for the user. This should always be a deliberate content decision, not a cosmetic change.

When you customize message titles:

Inconsistent or overly specific titles can distract users and reduce their ability to scan and recognize message intent.

For design constraints and implementation details, refer to  SAP Design System: Replacing Placeholder Text.

Error Messages

Error messages appear when an action cannot be completed. They interrupt the workflow by design, so the content must be especially clear and calm.

A good error message:

Do not blame the user or apologize on behalf of the system. Maintain a factual, steady tone that helps users get unstuck quickly.

For more information, see Message Box – Error Message.

Do

Product A does not exist.

Enter a valid postal code.

Employer Staging Date is a required field.

Don't

Oops, we didn't find this!

EmployerSupplement.StagingDate. cannot be null.

Warning Messages

Warning messages signal risk without blocking progress. They exist to help users make informed decisions and not to discourage action.

Use warnings when:

Focus on impact, not judgment.

For more information, see Message Box – Warning Message.

Do

The project schedule was last updated over a year ago. You're viewing data which might be outdated.

The quantity you have reported exceeds the quantity planned.

Special shipping conditions apply.

You're about to select postponement for auto enrollment. This will reset the start date to the first of the current month.

Don't

You haven't updated the schedule in a long time.

You chose postponement for auto enrollment. Some data might be reset.

Success Messages

Success messages confirm that an action has completed successfully. They reinforce trust and help users feel confident moving forward.

Keep success messages:

Avoid celebratory or emotional language. The design already signals success.

For more information, see Message Box – Success Message.

Do

Project 1234567 was created and assigned to team “ABC”.

Order 1234 was created.

Don't

Success! We've created the order 1234.

Information Messages

Information messages provide context users need to acknowledge but not act on immediately.

They should:

For more information, see Message Box – Information Message.

Do

Your booking will be reserved for 24 hours.

Confirmation Messages

Confirmation messages create a deliberate pause before irreversible or high‑impact actions.

They should:

When input is required, use sentence case for prompts.

For more information, see SAP Design System: Message Box under Confirmation Message.

Do

Approve order 12345?

Do you really want to delete order 12345?

Enter a note (explanation: Text input prompt in a note section)

Delete the booking 12345.

Booking 12345 will be deleted.

Don't

Are you really sure you want to delete this booking?