Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added Error messages.md
Empty file.
2 changes: 0 additions & 2 deletions docs/components/charts-overview/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,6 @@ A failure occurs when no data can be displayed within the chart. This can happen
- Explain cause: Why did the error appear?​ A clear and concise message explaining why the error happened, e.g. "Connection failure"
- Give solution: What can the user do to move forward?​ Add clear instructions for the user regarding what to do next to resolve the error, e.g. “Try again”

For more detailed information and examples, see the [UX writing style guide](docs/guidelines/language/error-messages.md).

## Missing data points

Indicate missing data with a special visual marker (like a different color or shape) to highlight the gaps without connecting them.
120 changes: 0 additions & 120 deletions docs/guidelines/language/best-practices.md

This file was deleted.

90 changes: 90 additions & 0 deletions docs/guidelines/language/empty-state-messages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
sidebar_position: 7
sidebar_label: Empty-state messages
title: Empty-state messages
doc-type: 'banner'
component-tabs: ['']
no_single_tab: true
description: 'Empty-state messages guide users, reduce confusion, and encourage meaningful action. Rather than leaving screens blank, they provide contextual messaging and clear next steps.'
---

#

## Best practice template

We follow this three-step approach when creating our empty-state messages. They explain why data is missing, suggest how to populate it, or offer links to relevant tools and documentation. Although not every empty-state message in a product requires all three steps, aim for this whenever possible.

| Step | Purpose | Description | Example |
| :--------- | :---------- | :--------- |:--------- |
| 1. | Heading | Explain this is empty intentionally and should be there, i.e. this empty space is not an error. | No projects added |
| 2. | Description | Give a clear reason why this space is empty. Provide context to help users understand the purpose of the empty-state space. | To display projects here, first add a project from your Project list. |
| 3. | Instructions | Explain how users can fill the space by adding links, buttons and suggestions to move the user forward. | Add projects |


## General rules

Use the template when the error stops users moving forward.

<div class="dos-and-donts" markdown>
<div class="dos" markdown>
Heading: No zones added
Description: Add zones to your profile to see them listed here.

Button: Add zones
</div>

<div class="donts" markdown>
Heading: No zones created
Description: Add region from your dashboard.

Button: Make sectors
</div>
</div>

Use clear action verbs to show users how to fill the empty state.

<div class="dos-and-donts" markdown>
<div class="dos" markdown>
Heading: No users added
Description: Add users in User management.
Button: Open User management
</div>
</div>

Use neutral framing of the empty state and avoid making it seem like a user failure.

<div class="dos-and-donts" markdown>
<div class="dos" markdown>
No users added
</div>

<div class="donts" markdown>
You haven’t added any of your users
</div>
</div>

Avoid “yet” or other expectation-related terms in titles.

<div class="dos-and-donts" markdown>
<div class="dos" markdown>
Heading: No users added
</div>

<div class="donts" markdown>
Title: No users added yet
</div>
</div>

## Dos and Don’ts

* Do make all messages consistent in terms of grammar and punctuation
* Do make sure users understand the space is not an error or a bug
* Do provide an option to fill the empty space with a button or link
* Don’t overcommunicate about the function of the empty state

## Related

* [Icon usage](https://ix.siemens.io/docs/icons/icon-usage#status-icons)
* [Error messages](#)
* [Warning messages](#)
* [Non-critical information messages](#)
101 changes: 0 additions & 101 deletions docs/guidelines/language/error-messages.md

This file was deleted.

Loading