diff --git a/docs/guidelines/language/operational-emails/_category_.json b/docs/guidelines/language/operational-emails/_category_.json new file mode 100644 index 000000000..0074c8839 --- /dev/null +++ b/docs/guidelines/language/operational-emails/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Operational emails", + "position": 11 +} diff --git a/docs/guidelines/language/operational-emails/general-information-and-administrative-emails.md b/docs/guidelines/language/operational-emails/general-information-and-administrative-emails.md new file mode 100644 index 000000000..32d0098a8 --- /dev/null +++ b/docs/guidelines/language/operational-emails/general-information-and-administrative-emails.md @@ -0,0 +1,189 @@ +--- +sidebar_position: 7 +sidebar_label: General information and administrative emails +title: General information and administrative emails +doc-type: 'banner' +description: 'In everyday operations, clear communication is key to maintaining transparency and trust. General notifications - covering administrative details, confirmations, and other essential updates outside specific operational categories - help keep stakeholders informed and processes organized. Well-structured messaging ensures clarity, reduces confusion, and supports smooth business interactions.' +--- + +# + +Note: Use these rules alongside the [General rules](#) and we have used [App name] as the standard placeholder for you to adapt individually to your product. All placeholders are shown with square brackets [placeholder]. + +## Subject lines + +Use a subject line that accurately reflects the email's content and purpose. + +
+
+ +- [App name] | New Terms of Use +- [App name] | Changes to your data options +- [App name] | Join our user testing +- [App name] | Tell us about your app experience + +
+
+ +## Body text + +### Agreements and confirmation + +Be specific when asking for confirmation or agreement. + +
+
+ +- You have to confirm the new Terms of Use until January 31, 2026. + +
+
+ +- Reading this email means you agree to our new Terms of Use. + +
+
+ +Include all relevant details of the agreement, order or change for the customer's records. + +
+
+ +- Your order for 5 “SINAMICS G120 Drives” (Order #QuantumShift Platform-2025-12345) has been received and processed. Estimated delivery: January 15, 2026. + +
+
+ +Avoid ambiguous phrasing that could lead to misunderstandings. + +
+
+ +- Your support contract for “Automation System S7-1500” has been renewed for one year, effective January 1, 2026. + +
+
+ +- We've extended your S7-1500 support. + +
+
+ +Include a method for the customer to review, modify or cancel the agreement or action if applicable. + +
+
+ +- You can review your subscription details or manage your preferences at any time through your [App name] account dashboard: [link to dashboard]. + +
+
+ +### Feedback and surveys + +Use a clear and polite invitation that explains the purpose of the survey. + +
+
+ +- We value your opinion and would appreciate your feedback on your recent interaction with our technical support team. + +
+
+ +Include an estimate of the time required to complete the survey. + +
+
+ +- This short survey will take approximately 5 minutes to complete. + +
+
+ +Include direct and secure links or buttons to make participation easier. + +
+
+ +- Share your thoughts via this secure link: [Link to survey]. + +
+
+ +- Go to our website to find the survey. + +
+
+ +### Communication information + +Include specific reference numbers or identifiers to help users track issues. + +
+
+ +- When contacting support, reference ticket ID: [App name]-2026-54321. + +
+
+ +Avoid hiding or making it difficult to find options for managing communication preferences or unsubscribing. + +
+
+ +- You can manage your email preferences here: [link to preference center]. +- Unsubscribe from emails here. + +
+
+ +## Best practice example for New Terms of Use + +**Subject**
+[App name] | New Terms of Use + +**Body** + +Dear [App name] user,
+There is an update to the Terms of Use for your [App name] account.
+What you need to do
+To continue using [App name], read and agree to the new Terms of Use by January 31, 2026. + +Button: Open Terms of Use + +If you have any questions or need assistance, contact our team at [email address]. + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Best practice example for customer survey invitation + +**Subject**
+[App name] | Tell us about your app experience + +**Body** + +Dear [App name] user,
+We’ve put together a short survey to gather your thoughts on various aspects of [App name], such as usability, performance and features.
+You can participate in the anonymous survey by March 2, 2025.
+This short survey will take approximately 5–7 minutes to complete. + +Button: Participate in the survey + +Thank you for helping us improve [App name].
+If you have any questions or need assistance, contact our team at [email address]. + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Related + +- [Non-critical information messages](../messaging/non-critical-information-messages.mdx) diff --git a/docs/guidelines/language/operational-emails/operational-emails-general-rules.md b/docs/guidelines/language/operational-emails/operational-emails-general-rules.md new file mode 100644 index 000000000..17c893d40 --- /dev/null +++ b/docs/guidelines/language/operational-emails/operational-emails-general-rules.md @@ -0,0 +1,427 @@ +--- +sidebar_position: 1 +sidebar_label: General rules +title: General rules +doc-type: 'banner' +description: 'In industrial applications, customer emails connect users to essential information, project updates and critical alerts. Well-written and clear customer emails keep operations running smoothly and users well-informed.' +--- + +# + +Note: We have used [App name] as the standard placeholder for you to adapt individually to your product. All placeholders are shown with square brackets [placeholder]. + +Keep emails short, add relevant information and avoid complex and lengthy sentences. + +
+
+ +- Renew your license before December 31, 2026. + +
+
+ +- It is recommended by us that you renew your license before December 31 avoiding a possible delay in service. + +
+
+ +Use past tense for completed events. + +
+
+ +- Payment was processed Tuesday, November 11, 2025. + +
+
+ +- Payment is processing Tuesday, November 11, 2025. + +
+
+ +Use future tense for upcoming actions or scheduled events. + +
+
+ +- We will deploy firmware Version 5.3 on November 22. + +
+
+ +- We deploy firmware Version 5.3 on November 22. + +
+
+ +Use the present perfect passive tense (have been / done) for system-generated confirmations or assignments. + +
+
+ +- You have been assigned the role of “Energy Analyst”. + +
+
+ +- The system assigned you the role of “Energy Analyst”. + +
+
+ +Use the past active tense when someone manually assigns a task or role. + +
+
+ +- John Smith assigned the following task to you: + +
+
+ +- You have been assigned the following task by John Smith. + +
+
+ +Use sentence case in your emails (capitalize only the first word of a sentence or heading and any proper nouns). + +
+
+ +- What’s happening + +
+
+ +- What’s Happening + +
+
+ +Use typographic double quotation marks for opening quotes “ (Unicode U+201C) and for closing quotes ” (Unicode U+201D) instead of single marks for consistency. + +
+
+ +- You have been assigned the role of “Energy Analyst”. + +
+
+ +- You have been assigned the role of ‘Energy Analyst’. + +
+
+ +## Subject lines + +Start the subject line with the application name. Use pipe separators to clearly structure the subject line and separate the product name, action and topic. + +
+
+ +- [App name] | Version 2.0 available + +
+
+ +- New Version 2.0 available +- [App name]: Version 2.0 available + +
+
+ +Include purpose and theme, avoiding generic or vague subject lines. + +
+
+ +- [App name] | Scheduled maintenance November 10, 2026, at 11:00 + +
+
+ +- [App name] | Maintenance soon + +
+
+ +Use language that reflects the urgency of the email and mention if action is required. + +
+
+ +- [App name] | Immediate action required | Security vulnerability fix +- [App name] | No action required | New events detected + +
+
+ +- [App name] | Security issues + +
+
+ +Keep the subject line as short as possible. Additional information should be provided in the body text. + +
+
+ +- [App name] | Immediate action required | Update + +
+
+ +- [App name] | Immediate action required | Update from old Version 2.4 to new Version 2.5 due to security issues + +
+
+ +## Body text + +Start with a polite salutation using “Dear” followed by a comma (American English). Do not use gendered titles or gendered forms of address. Use the recipient’s name if available. If no name is available, use a neutral greeting. For German translations, Siemens AG employees and partners can follow the [German Brand Guide](https://brandville.siemens.com/en/design-elements/language/inklusive-und-gendergerechte-sprache) for inclusive language. + +
+
+ +- Dear [App name] user, +- Dear John Schmidt, + +
+
+ +- Hi + +
+
+ +Repeat key words from the subject line in the body text. + +
+
+ +- Subject line: [App name] | Version 2.0 available
+ Body text: We’ve released Version 2.0 of [App name]. + +- Subject line: [App name] | One-time PIN for verification
+ Body text: You requested a one-time PIN to verify your identity. + +
+
+ +Use clear headings for users to easily scan body text for important information. + +
+
+ +- Heading: What happened +- Heading: What’s happening +- Heading: What you need to do + +
+
+ +Include a professional and polite closing with a descriptive signature. + +
+
+ +- Kind regards,
+ Your [App name] team + +
+
+ +- Best wishes,
+ Your friendly [App name] team + +
+
+ +### Time-related information + +Include specific times, dates and time zones whenever relevant. + +
+
+ +- The update will start automatically on November 10 between 02:00–04:00 CET (UTC+1). + +
+
+ +- The update will be next week. + +
+
+ +Include duration and instructions when applicable. + +
+
+ +- The registration link is valid for 24 hours. +- The PIN is valid for 15 minutes from the time you received this email. + +
+
+ +### Actions and links + +Include a clear message when users don’t have to do anything. + +
+
+ +- What you need to do
+ You don’t need to do anything. We’ll inform you when the data migration is complete. + +
+
+ +Provide a clear call-to-action when user actions are needed. + +
+
+ +- What you need to do
+ Restart your system after the update to ensure all changes take effect. + +
+
+ +Add minimal links, actions, or buttons in each email (we recommend one per email). + +
+
+ +- [Open App name] event list N + +
+
+ +If possible, provide call-to-actions in buttons instead of links. + +
+
+ +- Open dashboard (button) + +
+
+ +Use inline text links for additional information. + +
+
+ +- For additional information, see [webpage]. + +
+
+ +Use a full, live link when buttons are not possible in the email (see [External links and resources](../menu-functions-and-ui-labels/external-links-and-resources.md)). + +
+
+ +- Open your dashboard +- [App name].com/dashboard + +
+
+ +- {'https://example.com/'}[App name] + +
+
+ +### Responding options + +Include options for users to respond to or get support when possible. + +
+
+ +- If you have questions or need support, contact us at [email address]. + +
+
+ +Clearly state when an email is automated and cannot be replied to. + +
+
+ +- This email is automated: Do not reply. +- This is an automated email. Do not reply. + +
+
+ +### Disclaimer and footer + +Include a legal disclaimer, the company’s legal footer and any other required legal information.
+Check the correct legal text with your legal team. + +### Formatting + +Highlight important information but avoid excessive and mixed text formatting. + +
+
+ +- Review the attached maintenance report for details. + +
+
+ +- Review the attached **Maintenance Report** for details. + +
+
+ +Do not use emojis. + +
+
+ +- Welcome to [App name] – your energy management platform + +
+
+ +- We love you for joining us!!!! Welcome to the team ❤️ ❤️ + +
+
+ +### General best practice example + +**Subject** +[App name] | Scheduled maintenance November 10, 2026 + +**Body** +Dear [App name] user,
+ +What’s happeningy
+On Monday, November 10, between 02:00–04:00, we will perform system
+maintenance that will cause temporary service interruptions.
+What you need to do
+Restart your system after the maintenance window to apply all updates.
+If you have any questions or need assistance, contact our team at [email address]. + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Related + +- [Grammar](#) +- [Punctuation](#) +- [Time and time zones](../formatting/timezones.mdx) +- [Time-related messages](../messaging/time-related-messages.mdx) \ No newline at end of file diff --git a/docs/guidelines/language/operational-emails/operative-alarms-and-events.md b/docs/guidelines/language/operational-emails/operative-alarms-and-events.md new file mode 100644 index 000000000..65fead7eb --- /dev/null +++ b/docs/guidelines/language/operational-emails/operative-alarms-and-events.md @@ -0,0 +1,197 @@ +--- +sidebar_position: 3 +sidebar_label: Operative alarms and system event emails +title: Operative alarms and system event emails +doc-type: 'banner' +description: 'Critical notifications require careful communication. Emails about alarms and security events must inform users quickly while maintaining clarity and calm.' +--- + +# + +Note: Use these rules alongside the [General rules](#) and we have used [App name] as the standard placeholder for you to adapt individually to your product. All placeholders are shown with square brackets [placeholder]. + +## Subject lines + +State reason and criticality of the email directly in the subject line. + +
+
+ +- [App name] | Failure detected in Plant A +- [App name] | Critical risk of cyberattack +- [App name] | Threshold change for asset TG_1234 + +
+
+ +Use language that reflects the urgency of the email and mentions if actions are required. + +
+
+ +- [App name] | Immediate action required | Security vulnerability fix +- [App name] | No action required | New events detected + +
+
+ +- [App name] | Security issue + +
+
+ +## Body texts + +Be as specific as possible and tell users exactly what happened (what, when, how). + +
+
+ +- Critical alarm immediate attention required: Power supply failure detected in Plant A. +   • Power supply failure detected in Plant A.
+   • Event details: Overload detected on Transformer T-102 at 14:35 (UTC+2)
+   • Location: Nuremberg facility 32/A. + +
+
+ +Explain consequences and solutions about the event whenever possible. + +
+
+ +- Event: Overload detected on Transformer T-102 at 14:35 at Nuremberg facility. + +
+
+ +Avoid vague timing or unclear instructions. + +
+
+ +- Act immediately. + +
+
+ +- Act soon. + +
+
+ +Use clear, action-oriented instructions for users, avoiding words like may, should or recommend. + +
+
+ +- Switch to backup power and confirm system status in the portal. + +
+
+ +- You should switch to backup power when possible. +- You may want to switch to an alternative power supply. + +
+
+ +Explain if and how users can resolve issues or act with links, buttons, and suggestions. + +
+
+ +- No action required. The vulnerabilities have been located and logged. [Open Log files] for more details. + +
+
+ +- We found 1000 vulnerabilities! This means your plant is in danger! + +
+
+ +## Best practice example for alarm email + +**Subject** + +[App name] | Immediate action required | Batch threshold exceeded + +**Body** + +Dear [App name] user, + +Batch BTH-20260304-A127 threshold exceeded: + +- Parameter: Temperature +- Current value: 87.3°C +- Threshold limit: 85.0°C +- Deviation: +2.3°C (+2.7%) +- Duration: 00:03:47 + +Batch details: + +- Batch ID: BTH-20260304-A127 +- Product line: Beverage Mixing Line 3 +- Product: Orange Juice Concentrate +- Location: Plant A, Nuremberg facility +- Time: 2026-03-04 08:55:21 + +What you need to do + +- Open Batch list to stop processing or adjust thresholds. + +Button: Open Batch list + +If you have any questions or need assistance, contact our team at [email address]. + +Kind regards,
+[App name] team + +[Company disclaimer]
+[Company legal footer] + +## Best practice example for cyberattack notification + +**Subject** + +[App name] | Immediate action required | Critical risk of cyber attacks + +**Body** + +Dear [App name] user, + +A new cyberattack has been detected in your monitored environment. Immediate attention is required. + +Event details + +- Attack type: Unauthorized access attempt +- Location: Erlangen facility +- Time: 2026-03-04 08:55:21 + +What you need to do + +- Switch to backup security protocols immediately. +- Confirm system status in the Security portal. +- Review recent logs for suspicious activity. + +We will continue monitoring the system and provide updates as needed. + +Button: Open [App name] + +If you have any questions or need assistance, contact our team at [email address]. + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Related + +- [Dates](../formatting/date.mdx) +- [Time and time zones](../formatting/timezones.mdx) +- [Time related messages](../messaging/time-related-messages.mdx) +- [Error messages](../messaging/error-messages.mdx) +- [Warnings](../messaging/warning-messages.mdx) +- [Non-critical information messages](../messaging/non-critical-information-messages.mdx) diff --git a/docs/guidelines/language/operational-emails/reports-and-data-provisioning-emails.md b/docs/guidelines/language/operational-emails/reports-and-data-provisioning-emails.md new file mode 100644 index 000000000..7f822feaa --- /dev/null +++ b/docs/guidelines/language/operational-emails/reports-and-data-provisioning-emails.md @@ -0,0 +1,121 @@ +--- +sidebar_position: 5 +sidebar_label: Reports and data provisioning emails +title: Reports and data provisioning emails +doc-type: 'banner' +description: 'Well-written notifications about the completion and availability of generated reports or imported data ensure stakeholders can act quickly and confidently.' +--- + +# + +Note: Use these rules alongside the [General rules](#) and we have used [App name] as the standard placeholder for you to adapt individually to your product. All placeholders are shown with square brackets [placeholder]. + +## Subject lines + +Use precise and descriptive subject lines that immediately convey the email's purpose. + +
+
+ +- [App name] | Production efficiency report October 2025 available +- [App name] | Test report available +- [App name] | CSV import complete + +
+
+ +## Body text + +Use the full name of the report, dataset, or type of data being imported or migrated. + +
+
+ +- The monthly "Q3 2025 energy consumption optimization report" is now available. +- The import of your "Product inventory csv" is complete. + +
+
+ +- Your report is ready. + +
+
+ +Include a brief summary or key highlights from the report, especially if it's a regular deliverable. + +
+
+ +- This month's "Performance overview" highlights a 5% improvement in uptime for production line 2 due to recent sensor recalibrations. + +
+
+ +Include the reporting period or relevant dates for the data covered in the report. + +
+
+ +- The "Asset utilization report" for November 1–15, 2025 has been generated and is ready for your review. + +
+
+ +Include direct links to the report or data, minimizing steps for the user. + +
+
+ +- Your "Predictive maintenance analytics report" is available.
+ Button: [Open report] + +- The migrated "historical maintenance logs" are now fully accessible within Maintenance history.
+ Button: [Open Maintenance history] + +
+
+ +Use "you" and "your" for information or actions that are recipient-specific. Use neutral wording for shared or generally available information. + +
+
+ +- The monthly "Energy consumption report" is now available. +- Your requested "Product inventory csv" has been imported and is available to download. + +
+
+ +## Best practice example for report available + +**Subject** + +[App name] | Production efficiency report for October 2025 + +**Body** + +Dear [App name] user, + +Your monthly production efficiency report for October 2025 is now available. This report provides a detailed overview of your operational performance, including key metrics for production line 1. + +Key highlights from October + +- Overall equipment effectiveness: Increased by 3.5%, driven by reduced unplanned downtime. +- Downtime analysis: Minor stoppages decreased by 15%, indicating improved machine health. +- Energy consumption: 2% reduction in energy usage per unit produced, reflecting optimization efforts. + +Button: Open report + +If you have any questions or need assistance, contact our team at [email address]. + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Related + +- [Error messages](../messaging/error-messages.mdx) +- [Dates](../formatting/date.mdx) diff --git a/docs/guidelines/language/operational-emails/system-and-product-lifecycle-emails.md b/docs/guidelines/language/operational-emails/system-and-product-lifecycle-emails.md new file mode 100644 index 000000000..d778468b1 --- /dev/null +++ b/docs/guidelines/language/operational-emails/system-and-product-lifecycle-emails.md @@ -0,0 +1,190 @@ +--- +sidebar_position: 6 +sidebar_label: System and product lifecycle emails +title: System and product lifecycle emails +doc-type: 'banner' +description: 'In complex systems and product ecosystems, actionable and structured lifecycle notifications are critical for maintaining stability and performance.' +--- + +# + +Note: Use these rules alongside the [General rules](#) and we have used [App name] as the standard placeholder for you to adapt individually to your product. All placeholders are shown with square brackets [placeholder]. + +## Subject lines + +Include system or product lifecycle events, such as upcoming updates, directly in the subject line. + +
+
+ +- [App name] | Version 2.0 available +- [App name] | End-of-life announcement for "legacy control panel model X-200" +- [App name] | Test version 2.1 available for staging environment +- [App name] | Scheduled maintenance September 24, 2026, 01:00–13:00 + +
+
+ +## Body text + +### Version and release announcements + +Include the new version number and release date. + +
+
+ +- Version 2.1.0 will be available starting November 10. + +
+
+ +Add a summary of key changes or improvements. + +
+
+ +- This release includes enhanced firewall rules and improved logging. + +
+
+ +Include installation or update instructions with clear links, buttons or next steps. + +
+
+ +- Download the update via the [App name] portal and restart your system.
+ Button: Open [App name] + +
+
+ +### End-of-life announcements + +Include upgrade paths, migration guides and support options for product transitions. + +
+
+ +- Our dedicated support team is available to assist with your migration to the "smart factory OS". Contact us at [email address] or visit our [Migration portal]. + +
+
+ +Use absolute terms when describing the end of a product status or availability. + +
+
+ +- Industrial Gateway V7.2 will no longer receive security updates after June 30, 2026. +- Be advised that support for "control panel X-200" will officially end on December 31, 2026. Migrate to "control panel Z-200" for continued support and enhanced features. + +
+
+ +### Release approvals + +Include a clear request for approval. + +
+
+ +- Review and approve release V2.1.0 by November 10, 2026. + +
+
+ +Use links or attachments for release notes. + +
+
+ +- See attached release documentation for full details. + +
+
+ +### Staging and test releases + +Include the test environment details. + +
+
+ +- The staging release is now available at [web address] + +
+
+ +Use instructions for feedback or reporting issues. + +
+
+ +- Report any anomalies via the quality portal. +- Send your feedback to [email address] by September 22, 2026. + +
+
+ +### Maintenance announcements + +Include the maintenance window and impact. + +
+
+ +- Scheduled maintenance will occur on Nov 15, 02:00–04:00. Temporary downtime expected. + +
+
+ +Use instructions for preparation or follow-up. + +
+
+ +- Ensure backups are completed before the maintenance window.
+ Button: Open [App name] drive manager + +
+
+ +## Best practice example for new version + +**Subject** + +[App name] | Version 2.1.0 available + +**Body** + +Dear [App name] user, + +We’re excited to announce the release of Version 2.1.0. + +What’s new + +- Enhanced firewall rules for improved security +- Better logging for system diagnostics + +What you need to do + +- Download the update via the [App name] portal +- Restart your system to apply changes + +Button: Open [App name] + +If you have any questions or need assistance, contact our team at [email address]. + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Related + +- [Version](../formatting/software-versions.mdx) +- [Onboarding](../menu-functions-and-ui-labels/onboarding.md) +- [What’s new announcements](../menu-functions-and-ui-labels/whats-new-announcements.md) diff --git a/docs/guidelines/language/operational-emails/user-and-access-management-emails.md b/docs/guidelines/language/operational-emails/user-and-access-management-emails.md new file mode 100644 index 000000000..b180c11e3 --- /dev/null +++ b/docs/guidelines/language/operational-emails/user-and-access-management-emails.md @@ -0,0 +1,181 @@ +--- +sidebar_position: 2 +sidebar_label: User and access management emails +title: User and access management emails +doc-type: 'banner' +description: 'Clear, timely communication related to account creation, role assignments, invitations, onboarding and membership keep users informed and processes efficient. +' +--- + +# + +Note: Use these rules alongside the [General rules](#) and we have used [App name] as the standard placeholder for you to adapt individually to your product. All placeholders are shown with square brackets [placeholder]. + +## Subject lines + +State the clear purpose or topic of the email. + +
+
+ +- [App name] | Welcome to [App name] +- [App name] | Log in from new device +- [App name] | Notification of role change +- [App name] | One-time PIN for verification + +
+
+ +## Body text + +Start with a clear sentence describing the topic of the email. + +
+
+ +- Thank you for choosing [App name]. +- Your account has been successfully created. +- You requested a one-time PIN to verify your identity. +- A new device has been registered to this account: [{'user@example.com'}] + +
+
+ +Provide users with additional information or a summary. + +
+
+ +- What you need to do
+   • Open [App name]
+   • Start configuring your dashboard
+   • Explore key features: Real-time energy monitoring, load optimization and predictive analytics + +Button: Open + +
+
+ +
+
+- The information below relates to your newly registered device:
+   • Device name: Laptop123 +   • Device ID: ABCDEFGHI +   • Operating system: Windows +   • Date: November 11, 2026, 14:32 + +
+
+ +Provide users with clear next steps or instructions. + +
+
+ +- You are just a few steps away from starting your [App name] journey. To get started, register for an [App name] ID using your email address and create a strong, secure password. + +
+
+ +Never include sensitive information such as passwords directly in the email. + +
+
+ +- To set your password securely, visit the [App name] account portal. + +
+
+ +- Here is your default password: 12345 – change it here! + +
+
+ +Mention both previous and new states when access or role settings are changed. + +
+
+ +- There have been changes to your role for [App name]:
+ New role: Administrator
+ Previous role: Operator + +
+
+ +## Best practice example for onboarding + +**Subject** +[App name] | Welcome to [App name] + +**Body** +Dear [App name] user,
+Welcome to [App name]. Your account has been successfully created and is ready to use.
+Your access credentials
+- Role assigned: Energy Analyst
+- Tenant ID: [App name] NBG_001
+What you need to do
+- Open [App name]
+- Start configuring your dashboard
+- Explore key features: Real-time energy monitoring, load optimization, and predictive analytics + +Button: Open + +To set your password securely visit our [App name portal]. For your safety, we never include passwords directly in emails.
+If you have any questions or need assistance, contact our team at [email address]. + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Best practice example for role changes + +**Subject** +[App name] | Notification of role change + +**Body** +Dear [App name] user,
+There have been changes to your role for [App name]:
+New role: Administrator
+Previous role: Operator
+To see your current role, log in and go to your profile. + +Button: Open + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Best practice example for new devices + +**Subject** +[App name] | Registered new device + +**Body** +Dear [App name] user,
+A new device has been registered to your account: [{'user@example.com'}]
+Device name: Laptop123
+Device ID: ABCDEFGHI
+Operating system: Windows
+Date: November 11, 2026 at 14:32 + +Review your registered devices here: [Link] + +If you haven't registered this device on your account, reach out to your local cybersecurity contact and ask them to open an investigation.
+Thank you for your cooperation. + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Related +- [Dates](../formatting/date.mdx) +- [Time and time zones](../formatting/timezones.mdx) +- [Time-related messages](../messaging/time-related-messages.mdx) diff --git a/docs/guidelines/language/operational-emails/workflow-and-task-management-emails.md b/docs/guidelines/language/operational-emails/workflow-and-task-management-emails.md new file mode 100644 index 000000000..c530aed34 --- /dev/null +++ b/docs/guidelines/language/operational-emails/workflow-and-task-management-emails.md @@ -0,0 +1,216 @@ +--- +sidebar_position: 4 +sidebar_label: Workflow and task management emails +title: Workflow and task management emails +doc-type: 'banner' +description: 'Easily scannable and well-structured emails for workflow notifications help teams collaborate better and make faster decisions.' +--- + +# + +Note: Use these rules alongside the [General rules](#) and we have used [App name] as the standard placeholder for you to adapt individually to your product. All placeholders are shown with square brackets [placeholder]. + +## Subject lines + +State clear purpose or topic of the email with a descriptive title for context. + +
+
+ +- [App name] | Task #234 created | Spare part maintenance +- [App name] | Task #659 assigned to you | Log file management +- [App name] | Task #012 completed | Turbine overhaul +- [App name] | Maintenance scheduled for Nov 11, 2026, 10:00 + +
+
+ +State any time urgency, criticality or workflow impact within the subject line. + +
+
+ +- [App name] | Immediate action required | Firmware update +- [App name] | Task #134 | Review due Nov 11, 2026, 14:30 +- [App name] | Task #879 | Approval requested +- [App name] | Task #987 | Overdue + +
+
+ +## Body text + +Use clear and unambiguous headings to tell users what needs to be managed. + +
+
+ +- Task assigned +- Approval required +- Task overdue +- Review required + +
+
+ +- Task for you +- Task + +
+
+ +Include bullet points to enhance readability and highlight key information. + +
+
+ +- New task assigned
+   • Task ID: 462
+   • Task description: Spare part replacement for sensor 672_A
+   • Assigned by: Operator
+   • Assigned: February 10, 2026
+   • Due: February 15, 2026 + +
+
+ +Avoid vague statements about impact or required actions. + +
+
+ +- This update will require a restart and cause 5 minutes of downtime for "[Asset name]". + +- Software update
+  • Software: Update to version 4.3.6
+  • Date: November 10, 2025
+  • Time: 01:00–01:05 (UTC+2)
+  • Impact: Brief downtime (approx. 5 minutes) + +
+
+ +- This update might require a restart. + +
+
+ +## Task management and progress + +Include specific and quantifiable progress updates whenever possible. + +
+
+ +- Software patch deployment for SCADA system is 75% complete. +- Maintenance for "[Production Line 3]" is currently underway, estimated completion in 2 hours (10:00 UTC+2). + +
+
+ +Include expected completion times or clear next steps. + +
+
+ +- Expected completion by November 10, 2025, 22:00 (UTC+2). You will receive a notification once the system is fully operational. + +
+
+ +## Status updates + +Use clear indicators (operational, degraded, offline, standby) and state the impact immediately. + +
+
+ +- Status update | Remote monitoring system | Degraded performance +- Status update | Conveyor belt system | Offline +- Status update | Backup generator | Standby + +
+
+ +Avoid sending repetitive updates or leaving long gaps without communication during critical incidents. Only mention the previous status when it adds useful content. + +
+
+ +- Ticket #274 status changed from "active" to "closed". +- We will provide an update every 2 hours until resolution, or sooner if the status changes significantly. Our next update is scheduled for 14:00 (UTC+2). + +
+
+ +## Best practice example for task assignment + +**Subject** + +[App name] | Task #234 assigned to you + +**Body** + +Dear [App name] user, + +Task assigned + +- Task ID: 462 +- Task description: Spare part replacement for sensor 672_A +- Assigned by: Operator +- Assigned: February 10, 2026 +- Due date: February 15, 2026 + +What you need to do + +Open Task list for further task details. + +Button: Open task list + +If you have any questions or need assistance, contact our team at [email address]. + +This email is automated: Do not reply. + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Best practice example for overdue task reminder + +**Subject** + +[App name] | Immediate action needed | Overdue task #1234 "Firmware update" + +**Body** + +Dear [App name] user, + +Overdue task + +- Task: Firmware update V5.6.01 +- Due: November 22, 2025 + +What you need to do + +- Log in and perform update in Task manager + +Button: Open Task manager + +If you have any questions or need assistance, contact our team at [email address]. + +This email is automated: Do not reply. + +Kind regards,
+Your [App name] team + +[Company disclaimer]
+[Company legal footer] + +## Related + +- [Time-related messages](../messaging/time-related-messages.mdx) +- [Progress updates](../messaging/progress-updates.mdx) +- [Dates](../formatting/date.mdx) +- [Time and time zones](../formatting/timezones.mdx)