-
Notifications
You must be signed in to change notification settings - Fork 16
docs/uxw/messaging #162
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
docs/uxw/messaging #162
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
17b5147
Drei neue Seiten drin, eine alte Seite gelöscht
ZsuzsannaRacz 5c6dc92
docs: New error pages corrected
ZsuzsannaRacz ebbb7ed
docs: New error page
ZsuzsannaRacz a97b0c1
docs new error page
ZsuzsannaRacz 17ef65a
docs:uxw_errors_emptystate_infotips_updates
tokyojen 3a614e4
docs:uxw messages new updates
tokyojen 5745596
Fix frontmatter formatting
kathrinschalber 091f4e8
docs:uxw infotips_error_empty
tokyojen d80ef6e
docs:uxw_messages_update
tokyojen b574e8b
Merge branch 'main' into docs/uxw/error-messages
danielleroux File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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](#) | ||
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.