-
Notifications
You must be signed in to change notification settings - Fork 16
Docs/uxw/warning messages new 2 - testpurpose #173
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
Changes from all commits
a10c508
c0e8c8a
1409be0
a5480d4
ef5ecc9
0a9ff80
f86d0f7
c90263b
c91132f
495380e
ec2ec29
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| --- | ||
| sidebar_position: 99 | ||
| Sidebar_lable: Non-critical information messages | ||
| title: Non-critical information messages | ||
| doc-type: 'banner' | ||
| components-tabs: [''] | ||
| no_single_tab: true | ||
| description: Non-critical information messages come from the system and keep users updated on system status, operational changes, or relevant events and information. | ||
|
|
||
| --- | ||
|
|
||
| # | ||
|
|
||
| ## General rules | ||
|
|
||
| ### Keep messages short and concise. | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In MDX, the |
||
| <div class="dos" markdown> | ||
| Pump 3 cycle complete 14:32. | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="donts" markdown> | ||
| The operational sequence of Pump 3, located within Zone 2B, activated at 07:34 by admin 049 has completed its cycle (timestamp 14:32). | ||
| </div> | ||
| </div> | ||
|
|
||
| ### Use a professional, informative tone for routine updates and only include relevant information. | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="dos" markdown> | ||
| System backup completed at 21:00. | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="donts" markdown> | ||
| Don’t worry! We’ll make sure your backup is complete before your morning coffee on Friday! | ||
| </div> | ||
| </div> | ||
|
|
||
| ### Use clear timestamps for context, clarity, prioritization and record keeping. | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="dos" markdown> | ||
| Motor overload detected at 14:01:15 | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="dos" markdown> | ||
| Emergency stop activated at 21:03:27 | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="donts" markdown> | ||
| Notification list: | ||
| * Motor 3 overheating | ||
| * Valve 7 malfunction | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="donts" markdown> | ||
| System shutdown initiated 10 minutes ago. | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="donts" markdown> | ||
| Lubrication check due for press machine 2 in 3 days. | ||
| </div> | ||
| </div> | ||
|
|
||
| ### Avoid urgency wording as these types of notifications are typically not as critical as warnings. | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="dos" markdown> | ||
| System backup complete. | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="dos" markdown> | ||
| System backup completed at 15:00 | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="donts" markdown> | ||
| System backup done! Open and check now! | ||
| </div> | ||
| </div> | ||
|
|
||
| ### Avoid adding user actions when possible as these notifications should not impact the user workflow. | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="dos" markdown> | ||
| Sensors calibrated. No further action required. | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="donts" markdown> | ||
| Sensors calibrated. Click to check sensors (live link), calibration settings (live link) or manage your sensors (live link). | ||
| </div> | ||
| </div> | ||
|
|
||
| ### Use sentence casing to align with our UX writing guidelines | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="dos" markdown> | ||
| System will be updated within three hours. | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="dos" markdown> | ||
| Scheduled maintenance for Line 4 starts at 14:00. | ||
| </div> | ||
| </div> | ||
|
|
||
| ### Use minimal punctuation to keep notifications easy to read and without clutter or cognitive overload. | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="dos" markdown> | ||
| System update on line 4 starts at 14:00. | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="donts" markdown> | ||
| Notification: System update! Line: 4 / Starts: 14:00 (2pm). | ||
| </div> | ||
| </div> | ||
|
|
||
| ### Use industrial icons only when absolutely necessary and avoid emojis. | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="dos" markdown> | ||
| Line 3 shift schedule changed. See what's new. | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="dos-and-donts" markdown> | ||
| <div class="donts" markdown> | ||
| 🔄 Line 3 shift schedule updated. 👉 See what’s new. | ||
| </div> | ||
| </div> | ||
|
|
||
| ## Dos and Don'ts | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The heading References
|
||
|
|
||
| * Do use an alternative modal if your notifications are too long and cover multiple points | ||
| * Do make sure users understand the notification is not critical | ||
| * Don’t add multiple pieces of information into one notification | ||
| * Don’t insert multiple user actions into short notifications | ||
|
|
||
| ## Related | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a typo in the frontmatter.
Sidebar_lableshould besidebar_label.