UX writing principles

docs/guidelines/language/support-and-resources/UX-writing-principles.md

@@ -0,0 +1,85 @@
+---
+sidebar_position: 1
+sidebar_label: UX writing principles
+title: UX writing principles
+doc-type: 'banner'
+component-tabs: ['']
+no_single_tab: true
+description: 'UX writing principles guide the creation of guidelines and help writers make microcopy decisions every day when creating UI text for industrial applications.'
+---
+
+<style>{`
+table {
+  table-layout: fixed;
+  width: 100%;
+}
+table thead th:nth-child(1),
+table tbody td:nth-child(1) {
+  width: 33%;
+}
+table thead th:nth-child(2),
+table tbody td:nth-child(2) {
+  width: 33%;
+}
+table thead th:nth-child(3),
+table tbody td:nth-child(3) {
+  width: 34%;
+}
+table tbody td {
+  vertical-align: top;
+}
+`}</style>
+
+#
+
+Our UX writing principles are based on the [guiding principles for excellent design](https://ix.siemens.io/docs/guidelines/overview). They provide our writers, designers and developers with a clear rationale to make informed UX writing decisions, ensuring each product aligns with our standards and brand identity. 
+
+We’ve refined our approach into eight core UX writing principles. These help us make informed and thoughtful microcopy decisions when creating UI text for industrial applications. 
+
+## Trust
+
+| What | Why | How |
+| --- | --- | --- |
+| We increase confidence and remove doubt.<br/><br/>We help our users with fast and secure decision-making. | Users make high-risk decisions at work, e.g., initiate or postpone maintenance.<br/><br/>Users need predictable interactions that create trust in the product as well as the brand. | We write with the correct level of urgency (warnings, alarms, errors, and consequences).<br/><br/>We write with with consistency using user mental models, conventions and standards to remove the memory burden and prevent errors.<br/><br/>We provide clear constraints so users can trust their actions, their consequences, and the product. |
+
+## Accuracy
+
+| What | Why | How |
+| --- | --- | --- |
+| Our writing is specific and concise.<br/><br/>We ensure users understand the words in the same way.<br/><br/>We leave little room for interpretation or guessing. | Users should not have to interpret text, dialogs or terms.<br/><br/>Users cannot have doubt as to the meaning of the word.<br/><br/>Users cannot have any doubt as to the consequences of their actions. | We do user research to become familiar with user terminology.<br/><br/>We use precise, true, explicit, and exact wording.<br/><br/>We perform UX wording reviews and collaborate with designers.<br/><br/>We write additional guidance to users for complex workflows.  |
+
+## Consistency
+
+| What | Why | How |
+| --- | --- | --- |
+| We write with uniformity across screens, apps, and products from Siemens.<br/><br/>Users can rely on our writing to be the same across screens and products.<br/><br/>We write with the same voice and tone. | Users don't have time to get used to changes or variations when carrying out tasks in their daily work.<br/><br/>Users should not have to wonder whether different words, situations, or actions mean the same thing. | We ensure the same or similar contexts have the same wording.<br/><br/>We follow platform and industry conventions.<br/><br/>We apply voice and tone guidelines consistently. |
+
+## Efficiency
+
+| What | Why | How |
+| --- | --- | --- |
+| We move users through their daily work tasks easily and quickly.<br/><br/>We move users through high-risk and exceptional tasks rapidly.<br/><br/>Users move through our products logically and find our writing intuitive. | Users within industrial settings need immediate feedback.<br/><br/>Users within industrial settings need to filter information quickly.<br/><br/>Users within industrial settings need to make decisions quickly. | We make text scannable and brief.<br/><br/>We offer contextual help and reduce information users must remember.<br/><br/>We present the right words at the right time, or not at all. |
+
+## Human
+
+| What | Why | How |
+| --- | --- | --- |
+| We create products with engaging and supportive interaction.<br/><br/>We have authentic conversations with our users.<br/><br/>We write products that sound human. | Users need human-centric language based on their needs and behaviors.<br/><br/>Our products need to match our users' way of thinking and working. | We work to understand the technical terms required by the users without using excessive jargon.<br/><br/>We design end-to-end conversations for tasks. |
+
+## Empathy
+
+| What | Why | How |
+| --- | --- | --- |
+| We put ourselves in the users' shoes.<br/><br/>We anticipate their confusion and pain points.<br/><br/>We understand what our users want, need, and are engaged by. | Users want products that understand their requirements.<br/><br/>We genuinely care about the people we design for.<br/><br/>We need to write according to our users' emotional state.<br/><br/>Industrial application users represent more sensitive and urgent situations. | We conduct user and product research.<br/><br/>We use personas, including pain points and needs.<br/><br/>We use user journeys that include their daily tasks.<br/>We apologize when appropriate. |
+
+## Accessibility
+
+| What | Why | How |
+| --- | --- | --- |
+| We write for everyone, whatever their expertise or background.<br/><br/>We aim to implement WCAG principles. | Users have varying literacy skills in all levels of life.<br/><br/>Users have cognitive, visual, and motor impairments.<br/><br/>Users, regardless of ability or circumstance, must get the information they need. | We follow our company's voice and tone guidelines.<br/><br/>We write at the correct literacy level for our users.<br/><br/>We run [accessibility](https://ix.siemens.io/docs/guidelines/accessibility/overview) checks.|
+
+## Branding
+
+| What | Why | How |
+| --- | --- | --- |
+| We follow product principles.<br/><br/>We follow company voice and tone principles.<br/><br/>We speak the brand. | Users need to know they are using a product from our company.<br/><br/>Products need to feel familiar to users.<br/><br/>We want users to recognize and recommend our products. | We apply our UX writing guidelines and continually align them with the company’s voice and tone.<br/><br/>We focus on creating microcopy with one voice instead of marketing copy within our industrial applications.|

docs/guidelines/language/support-and-resources/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Support and resources",
+  "position": 12
+}