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
120 changes: 0 additions & 120 deletions docs/guidelines/language/best-practices.md

This file was deleted.

162 changes: 162 additions & 0 deletions docs/guidelines/language/non-critical-information-messages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
---
sidebar_position: 99
Sidebar_lable: Non-critical information messages
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's a typo in the frontmatter. Sidebar_lable should be sidebar_label.

sidebar_label: 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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

In MDX, the class attribute should be className, and the markdown attribute should be set to markdown="true". This issue is present in multiple div elements throughout this new file. Please correct all occurrences to ensure the components render correctly.

<div className="dos-and-donts" markdown="true">

<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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The heading Dos and Don'ts does not follow the style guide. According to line 91 of the repository style guide, the title should be Dos and Don’ts, using a right single quotation mark.

## Dos and Don’ts
References
  1. The title is "Dos and Don’ts" (link)


* 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

Loading