diff --git a/blog/tags.yml b/blog/tags.yml index 9dd7707f0..71f5e5be0 100644 --- a/blog/tags.yml +++ b/blog/tags.yml @@ -2,3 +2,7 @@ release: description: 'Blog posts about new Industrial Experience design system releases' merging: description: 'Merging activities from other design systems at Siemens' +ux: + description: 'Posts about user experience and UX writing topics' +development: + description: 'Posts about implementation, tooling and development workflows' diff --git a/docs/components/input-date-time/code.mdx b/docs/components/input-date-time/code.mdx index be82bfc3d..9a43513ae 100644 --- a/docs/components/input-date-time/code.mdx +++ b/docs/components/input-date-time/code.mdx @@ -1,6 +1,7 @@ --- doc-type: 'tab-item' formReady: true +description: 'Code examples for date time input, including states, validation, slots and min/max dates.' --- import DatetimeInputPlayground from '@site/docs/autogenerated/playground/datetime-input.mdx'; import DatetimeInputDisabledPlayground from '@site/docs/autogenerated/playground/datetime-input-disabled.mdx'; diff --git a/docs/guidelines/conversational-design/designing-conversations/ad-hoc-conversations.md b/docs/guidelines/conversational-design/designing-conversations/ad-hoc-conversations.md index 7e7901a13..c73cdf767 100644 --- a/docs/guidelines/conversational-design/designing-conversations/ad-hoc-conversations.md +++ b/docs/guidelines/conversational-design/designing-conversations/ad-hoc-conversations.md @@ -6,7 +6,7 @@ hide_table_of_contents: false doc-type: 'banner' component-tabs: [''] no_single_tab: true -description: "Even in industrial scenarios, users test and play with chatbots. Some ad hoc interactions can be fun and build relationships between your users and chatbots, however some can be undesirable and damaging for your brand. To mitigate this risk, it’s important to implement filters and set up clear guidelines. Companies and projects can decide if they need to implement more than a basic response and give, for example, a warning message. Either way, most chatbots respond in the same way when it comes to offensive or inappropriate user queries." +description: "Ad hoc chatbot interactions can strengthen user trust, but offensive or off-topic input can harm your brand. Use filters and response rules to keep interactions safe and on track." --- # diff --git a/docs/guidelines/conversational-design/designing-conversations/ending-conversations.md b/docs/guidelines/conversational-design/designing-conversations/ending-conversations.md index d246d85c2..73a9b957e 100644 --- a/docs/guidelines/conversational-design/designing-conversations/ending-conversations.md +++ b/docs/guidelines/conversational-design/designing-conversations/ending-conversations.md @@ -6,7 +6,7 @@ hide_table_of_contents: false doc-type: 'banner' component-tabs: [''] no_single_tab: true -description: "As with any human to human interaction, there’s always an ending to give participants closure and end on a positive note. This is the same for every chatbot interaction, including industrial chatbots. Although it seems an easy communicative function, ending interactions well can achieve multiple goals that help users, chatbot teams and chatbots. It’s an opportunity to get useful feedback to train your chatbot, create a clear signal that the interaction is complete, and set the tone for the next interaction interactions." +description: "End chatbot interactions with clear closure and a positive tone. Well-designed endings confirm completion, support feedback collection and improve future interactions." --- # diff --git a/docs/guidelines/conversational-design/designing-conversations/handling-errors.md b/docs/guidelines/conversational-design/designing-conversations/handling-errors.md index f09fccaec..3e24e4dd6 100644 --- a/docs/guidelines/conversational-design/designing-conversations/handling-errors.md +++ b/docs/guidelines/conversational-design/designing-conversations/handling-errors.md @@ -6,7 +6,7 @@ hide_table_of_contents: false doc-type: 'banner' component-tabs: [''] no_single_tab: true -description: "When talking about chatbots and the mistakes they make, it’s always talked about handling them ‘gracefully’. However, in industrial situations, they must also be handled quickly so users can move on and possibly get another support source. There are often time-sensitive actions within industrial situations that require chatbots and workers to move quickly to find solutions. If a chatbot response is inaccurate or the chatbot cannot give users the solution they need, it can be consequential and even costly." +description: "In industrial contexts, chatbot errors must be handled clearly and quickly. Give users immediate feedback, explain limits and guide them to an alternative path." --- # diff --git a/docs/guidelines/language/capitalization-and-proper-nouns.md b/docs/guidelines/language/capitalization-and-proper-nouns.md new file mode 100644 index 000000000..9612c5202 --- /dev/null +++ b/docs/guidelines/language/capitalization-and-proper-nouns.md @@ -0,0 +1,404 @@ +--- +sidebar_position: 4 +sidebar_label: Capitalization and proper nouns +title: Capitalization and proper nouns +doc-type: 'banner' +component-tabs: [''] +no_single_tab: true +description: 'Capitalization means using uppercase letters (A, B, C) instead of lowercase letters (a, b, c). This section provides clear rules for capitalizing names, brands, technical terms, and UI elements.' +--- + + +## General rules + +Use sentence case in your applications (capitalize only the first word of a sentence or heading, and any proper nouns). As the dominant trend in digital interfaces, we use sentence case to support readability, accessibility and consistency. + +
+
+ +
+
+ +
+
+ +Do not capitalize generic system or technology terms. + +
+
+ +
+
+ +
+
+ +Do not capitalize common technology terms that were initially proper nouns and capitalized, e.g. internet, website and email. + +
+
+ +
+
+ +
+
+ +## Proper nouns + +Always capitalize proper nouns (specific names) including: + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +Always capitalize product names, systems, and third-party platforms exactly as trademarked, using the official spelling and capitalization. + +
+
+ +
+
+ +
+
+ +Capitalize official service and portal names you have created and named within your product as proper nouns. + +
+
+ +
+
+ +
+
+ +## Headings + +Use sentence case for all headings (including table headings). Capitalize only the first word and proper nouns. See [Punctuation](#). + +
+
+ +
+
+ +
+
+ +## Button labels and UI elements + +Use sentence case for button labels and UI elements. Capitalize only the first word and proper nouns. + +
+
+ +
+
+ +
+
+ +Slashes do not create new sentences. Treat them like "and" or "or". Capitalize only the first word and proper nouns. See [Punctuation](#). + +
+
+ +
+
+ +
+
+ +## Acronyms and abbreviations + +Capitalize all letters in acronyms and abbreviations. Do not use periods between letters. + +
+
+ +
+
+ +
+
+ +## Capitalization exceptions + +"OK" appears in all caps. + +
+
+ +
+
+ +
+
+ +Use capitalization for the first word of app functions and menu items when navigating users, e.g. menu items, label text, button text, etc. even when they are not proper nouns. This exception is to help with scanning and readability. + +
+
+ +
+
+ +
+
+ +Use periods for Latin abbreviations. + +
+
+ +
+
+ +
+
+ +Don't use periods for geographic abbreviations. Capitalize all country codes. + +
+
+ +
+
+ +
+
+ +## Lists and bullet points + +Capitalize the first word of each list item. Use sentence case throughout. For punctuation in lists, see [Punctuation: Period/full stop](#). + +
+
+ +
+
+ +
+
+ +## Hyphenated words + +Capitalize only the first word of a hyphenated compound (nouns connected with hyphens) unless the second part is a proper noun. + +
+
+ +
+
+ +
+
+ +## Special cases + +Use lowercase for file extensions. Use the original case for file names and paths. + +
+
+ +
+
+ +
+
+ +Use the exact case used in programming when writing or referencing actual code or technical identifiers, but not for UI text or end-user documentation. + +camelCase (variables, functions, methods): + +
+
+ +
+
+ +
+
+ +dash-case (URLs, file names, CSS classes): + +
+
+ +
+
+ +
+
+ +## Related + +- [Voice and tone](basics/voice-and-tone.md) +- [UI terminology](menu-functions-and-ui-labels/ui-terminology.md) +- [Punctuation](punctuation.md) diff --git a/docs/guidelines/language/proper-nouns.md b/docs/guidelines/language/proper-nouns.md index 42cc422ed..740ff3b49 100644 --- a/docs/guidelines/language/proper-nouns.md +++ b/docs/guidelines/language/proper-nouns.md @@ -1,49 +1,397 @@ --- sidebar_position: 4 sidebar_label: Proper nouns -title: Proper nouns +title: Capitalization and proper nouns doc-type: 'banner' component-tabs: [''] no_single_tab: true -description: 'Learn the guidelines for using proper nouns correctly in your text. This subchapter will help you understand when and how to capitalize names, brands, and other specific terms to maintain consistency and professionalism.' +description: 'Capitalization means using uppercase letters (A, B, C) instead of lowercase letters (a, b, c). This section provides clear rules for capitalizing names, brands, technical terms, and UI elements.' --- # -## Capitalize proper nouns +## General rules -- A proper noun is the name of a particular person, place, or object that is spelled with a capital letter +Use sentence case in your applications (capitalize only the first word of a sentence or heading, and any proper nouns). As the dominant trend in digital interfaces, we use sentence case to support readability, accessibility, consistency and localization. -- Examples of proper nouns in English are Jennie, Edinburgh, and Digital Enterprise Labs +
+
+ +
+
+ +
+
-- In contrast, a common noun is a noun that is the name of a group of similar things, such as "pump" or "valve", and not of a single person, place, or thing and is not capitalized +Do not capitalize generic system or technology terms. -- In the context of industrial applications, proper nouns might be company and product names, tools or existing technical and legal terms +
+
+ +
+
+ +
+
-- Avoid making up your own proper nouns, e.g. ball valve instead of Ball Valve +Do not capitalize common technology terms that were initially proper nouns and capitalized, e.g. internet, website and email. -## Siemens proper nouns +
+
+ +
+
+ +
+
-- Siemens Corporate Information +## Proper nouns -- Siemens Privacy Notice +Always capitalize proper nouns (specific names) including: -- Siemens Terms of Use +
+
+ +
+
-- Siemens Cookie Notice +
+
+ +
+
+ +
+
-- Siemens Digital ID +Always capitalize product names, systems, and third-party platforms exactly as trademarked, using the official spelling and capitalization. -- SIMATIC PCS myExpert, iOS, JavaScript +
+
+ +
+
+ +
+
-- Siemens Industry Online Support +Capitalize official service and portal names you have created and named within your product as proper nouns. -- Siemens Service & Support +
+
+ +
+
+ +
+
-## Technical terms +## Headings -- Operating systems: iOS, Android, Windows, Linux +Use sentence case for all headings (including table headings). Capitalize only the first word and proper nouns. See punctuation guidelines [LINK]. -- Programming languages: JavaScript, etc. +
+
+ +
+
+ +
+
-- Industrial engineering: P&ID diagram, etc. +## Button labels and UI elements + +Use sentence case for button labels and UI elements. Capitalize only the first word and proper nouns. + +
+
+ +
+
+ +
+
+ +Slashes do not create new sentences. Treat them like "and" or "or". Capitalize only the first word and proper nouns. See punctuation guidelines [LINK]. + +
+
+ +
+
+ +
+
+ +## Acronyms and abbreviations + +Capitalize all letters in acronyms and abbreviations. Do not use periods between letters. + +
+
+ +
+
+ +
+
+ +## Capitalization exceptions + +"OK" appears in all caps. + +
+
+ +
+
+ +
+
+ +Use capitalization for the first word of app functions and menu items when navigating users, e.g. menu items, label text, button text, etc. even when they are not proper nouns. This exception is to help with scanning and readability. + +
+
+ +
+
+ +
+
+ +Use periods for Latin abbreviations. + +
+
+ +
+
+ +
+
+ +Don't use periods for geographic abbreviations. Capitalize all country codes. + +
+
+ +
+
+ +
+
+ +## Lists and bullet points + +Capitalize the first word of each list item. Use sentence case throughout. For punctuation in lists, see period/full stop [LINK]. + +
+
+ +
+
+ +
+
+ +## Hyphenated words + +Capitalize only the first word of a hyphenated compound unless the second part is a proper noun. + +
+
+ +
+
+ +
+
+ +## Special cases + +Use lowercase for file extensions. Use the original case for file names and paths. + +
+
+ +
+
+ +
+
+ +Use the exact case used in programming when writing or referencing actual code or technical identifiers, but not for UI text or end-user documentation. + +camelCase (variables, functions, methods): + +
+
+ +
+
+ +
+
+ +dash-case (URLs, file names, CSS classes): + +
+
+ +
+
+ +
+
+ +## Related + +- [Voice and tone](basics/voice-and-tone.md) +- [UI terminology](menu-functions-and-ui-labels/ui-terminology.md) +- [Punctuation](punctuation.md) diff --git a/docs/guidelines/language/punctuation.md b/docs/guidelines/language/punctuation.md index d13778b8d..e53beb3a8 100644 --- a/docs/guidelines/language/punctuation.md +++ b/docs/guidelines/language/punctuation.md @@ -5,177 +5,644 @@ title: Punctuation doc-type: 'banner' component-tabs: [''] no_single_tab: true -description: 'Master the use of punctuation to improve the readability and comprehension of your text. This section covers the rules and best practices for using punctuation marks to ensure your writing is clear and precise.' +description: 'We recommend a minimal approach to punctuation as it can add cognitive load and presents consistency challenges across products, portfolios and teams.' --- # -## Minimalist punctuation +## Ampersand & + +Use only when part of an official or registered product, or company name. Although space-saving, many screen readers are unable to interpret ampersands correctly. + +
+
+ +
+
+ +
+
+ +The common phrase “About & legal” always uses the ampersand. This is the only exception in our guidelines for ampersand use. + +
+
+ +
+
+ +
+
-Always consider whether necessary +## Apostrophe ’ -
-`!` Exclamation mark for high-level warnings only! +Apostrophes look like a single quotation mark, show ownership and create contractions (I’m, you’re, they’re). + +
+
+
    +
  • customer’s role (single customer)
    • +
  • customers’ roles (multiple customers)
    • +
  • The folder’s contents are displayed in the dashboard.
    • +
  • Today’s date is displayed in the banner.
    • +
+
-
-`?` Question mark only if necessary +With our minimal punctuation approach, we limit apostrophes by using nouns as adjectives. + +
+
+
    +
  • Select file location.
    • +
  • Edit user profile information.
    • +
  • View employee details.
    • +
  • Set time format.
    • +
+
+
+
    +
  • Select the file’s location.
    • +
  • Edit user’s profile information.
    • +
  • View employee’s details.
    • +
  • Set the time’s format.
    • +
+
-
-`:` Use colons: especially to introduce lists +## Asterisk * + +Use a single asterisk to indicate required fields. Place them immediately after the text without a space. A legend explaining what the asterisk means, typically at the top of forms, is no longer necessary as asterisks are widely understood to mean mandatory. + +Note: If your design system adds asterisks automatically via attributes, remove the manual symbol to prevent duplication. + +
+
+
    +
  • Device name*
    • +
+
+
+
    +
  • Device name *
    • +
+
-
-`.` Full stops at the end of all full sentences +## Bullet points   • + +Use bullet points to break down complex information into scannable, digestible chunks. They help users quickly identify key points and reduce cognitive load. Use consistent bullet styles within a single list or section. + +For unordered lists, use round bullets (•). For ordered lists, use numbers followed by a period (1.). Maintain parallel structure; if one item is a complete sentence, make all items complete sentences. + +Add one space after the bullet point or number before the text begins. + +
+
+
    +
  • Key features:
      • Real-time monitoring
      • Automated alerts
      • Custom dashboards
    • +
  • Setup steps:
    1 Connect device
    2. Configure settings
    3. Start monitoring
    • +
  • Benefits include:
      • Increased efficiency across all operations.
      • Reduced downtime through predictive maintenance.
      • Enhanced visibility into system performance.
    • +
+
-
-`.` Full stops before all file extensions: .csv .txt .zip +## Colon : + +Use to introduce lists, options, descriptions, settings and preferences to visually separate labels and input fields. Colons help to enhance readability when both the labels and input area are not visually distinguishable. When it’s clear within the interface what needs to be completed, remove the colon. + +
+
+
    +
  • Username Felix (color to distinguish fields)
    • +
  • Username: Felix (colon to visually separate label and field)
    • +
+
-
-`.` Consistent use of full stops throughout the application +## Comma , + +Use commas to separate data in lists for clarity. + +
+
+
    +
  • Jane Roe, Admin, 3 plant zones
    • +
+
+
+
    +
  • Jane Roe Admin 3 plant zones
    • +
+
-
-`…` Ellipsis only for transitional text: Upload… +The Oxford comma is placed before the final “and” or “or” in a list of three or more items. It is acceptable to use and can help avoid ambiguity, but omit it when space is limited in the UI. Remove the Oxford comma especially if it causes text to wrap or overflow in constrained UI elements such as labels, tooltips, or buttons. + +
+
+
    +
  • Save, print, or share this document.
    • +
  • Settings include notifications, privacy, and security.
    • +
  • Status: Connected to WLAN, Bluetooth, and USB.
    • +
  • Before proceeding, save your work, close all applications, and disconnect external devices.
    • +
  • Mix components A and B, catalyst C, and hardener D in separate containers.
    • +
+
-
-`'` Single quotation mark for possession: Customer’s role (single), customers’ roles (plural) +## Ellipsis … + +Use ellipsis with transitional text to inform users that something is happening and ongoing. There are never spaces between the text and the ellipsis. + +
+
+
    +
  • Searching…
    • +
  • Retrieving notifications…
    • +
+
+
+
    +
  • Searching . . .
    • +
  • Retrieving notifications.
    • +
+
-
- No quotation mark or brackets for plurals: PDFs + +They are also sometimes used to show that a new dialog box will open within the UI, e.g. "Print…" or "Save as…", but as this comes with consistency challenges it is slowly being removed from UX writing guidelines. + +
+
+
    +
  • Save as
    • +
+
+
+
    +
  • Save as…
    • +
+
-
-`&` Avoid ampersands unless in a product or company name: Siemens & Halske AG +## Hyphen ‐ + +Hyphens join words together (drop-down menu) and connect prefixes to words (non-technical). Use hyphens to avoid confusion and enhance readability. Never use spaces before or after the hyphen. + +
+
+
    +
  • read-only memory
    • +
  • user-friendly
    • +
  • pre-provisioned
    • +
+
+
+
    +
  • preprovisioned
    • +
+
-
-`*` Avoid asterisks in applications +Remove hyphens for widely understood terms that have evolved beyond needing them. + +
+
+
    +
  • email
    • +
  • database
    • +
  • ecommerce
    • +
+
+
+
    +
  • e-mail
    • +
  • data-base
    • +
  • e-commerce
    • +
+
-
-`(` Avoid brackets ( ) and [ ] +## Minus sign − + +Use the proper minus sign (−) rather than a hyphen (-) when expressing negative values or subtraction. In UI contexts such as labels, values, or data displays, the minus sign should be used to ensure mathematical clarity. The minus sign should be placed directly before the number with no intervening space except for mathematical operations for readability. + +
+
+
    +
  • The temperature dropped to −12°C
    • +
  • Balance: −$50.00
    • +
  • 10 − 3 = 7
    • +
+
+
+
    +
  • The temperature dropped to -12°C (hyphen as minus sign)
    • +
  • Balance: -$50.00 (hyphen as minus sign)
    • +
  • 10-3=7
    • +
+
-
-`;` Avoid semi-colons +## En and em dashes – — + +They look similar, but there are two dashes and we use them differently from hyphens and the minus sign. + +Use the smaller en dash to connect times, numbers and date ranges. Use the longer em dash to replace commas, brackets or colons. + +Don’t use spaces when using en dashes for number ranges. In all other cases, add spaces before and after en dashes and em dashes for digital readability. + +Em dashes are often used in longer texts to make part of the text stand out, such as telling users about special or new application features. To avoid em dash overuse, we typically use commas instead within UI text to connect phrases. + +
+
+
    +
  • Maintenance planned Monday – Thursday (en dash)
    • +
  • Threshold range: 15–20 (en dash)
    • +
  • Our new obsolescence feature, available now, gives you more sustainability opportunities
    • +
+
+
+
    +
  • Maintenance planned Monday - Thursday (hyphen)
    • +
  • Threshold range: 15-20 (hyphen)
    • +
  • Our new obsolescence feature — available now — gives you more sustainability opportunities (em dashes)
    • +
+
-
-`:` Avoid and remove colons whenever possible, for example Username instead of Username: +## Exclamation mark ! + +Use only for high-level alarms. We don’t use them for messages, notifications or for any other communication with our users. And, as the exclamation mark is often within warning icons, it doesn’t need to be added to text to signify the strength of our messaging. + +
+
+
    +
  • Critical system error detected. Immediate attention required!
    • +
+
+
+
    +
  • Welcome to your dashboard!
    • +
+
-## Formats +## Forward slash / + +Use forward slashes sparingly in UI text. They work well for established patterns and technical contexts, but can reduce clarity and accessibility. Forward slashes are appropriate for established UI patterns like on/off and country/region, mathematical fractions, file paths, and compact form labels where space is limited. Use lowercase in body text (on/off) and sentence case following standard capitalization rules (see Capitalization guide). Use lowercase after the slash unless it’s a proper noun. + +Avoid spaces before or after the slash unless spaces enhance clarity in larger text blocks or when there is complex formatting where spaces can enhance readability. + +
+
+
    +
  • country/region
    • +
  • 3/4 cup
    • +
  • Toggle on/off
    • +
  • C:/Program Files/Industry
    • +
  • Enable notifications and/or alerts
    • +
+
+
+
    +
  • country / region
    • +
  • 3 / 4 cup
    • +
  • Click Save/Export
    • +
  • C: / Program Files / Industry
    • +
  • Enable notifications and / or alerts
    • +
+
+
-- 12-hour clock: 11am and 11pm or 11AM and 11PM +## Parentheses and brackets -- 24-hour clock: 11:00 and 23:00 +There are several types of parentheses (also known as brackets). For all variations, there are no spaces between the parentheses and the text within them. However, there are spaces before and after all variations except when followed by another punctuation mark. -- Date: Monday, January 12, 2021 +### Round ( ) -- Money: $400,456.50 +Use sparingly to give users additional information or clarify messaging. Consider alternative punctuation first, e.g. commas or dashes. Use when the information is supplementary but helpful. -- Measurement and quantities: 30 mm +
+
+
    +
  • Available in multiple formats (PDF, DOCX, TXT)
    • +
  • Review the settings (see Figure 1).
    • +
+
+
+
    +
  • Our new software version is here. Get ready for enhanced features, improved performance (and a seamless user experience).
    • +
+
+
-- Hyphen for ranges: 10-40% +### Curly \{ \} -- Numbers: Use No. as an abbreviation for number, no spacing between abbreviated No. and number: No.8 +Use for variables, placeholders and programming. -
-
-
    -
  • 11am
    • -
  • Monday, January 12, 2021
    • -
  • €999.50
    • -
  • €2.5 million
    • -
  • $400,456.50
    • -
  • £320
    • -
  • 30 mm
    • -
  • 10 oz
    • -
  • 10-40%
    • -
  • No.7
    • -
  • Number 7
    • -
+
+
+
    +
  • Service alert: `{deviceId}` - `{errorCode}`
    • +
  • Template: `{customerName}`
    • +
+
-
-
    -
  • 11 a.m.
    • -
  • Monday, 12 January 2021
    • -
  • €999,50
    • -
  • €2,5 million
    • -
  • $400.456,50
    • -
  • 320£
    • -
  • 30 mms
    • -
  • 10 oz.
    • -
  • 10–40%
    • -
  • #7
    • -
  • Num 7
    • -
+ +### Square [ ] + +Rarely used within UI text. Sometimes used for units but more common within academic authoring, quotes and translations to indicate errors, omissions or text in other languages. + +
+
+
    +
  • Save assets, e.g. valves [Ventil] within your plant zones.
    • +
  • “A real game-changer for the [food and beverage] industry.”
    • +
  • Room temperature [°C]
    • +
+
+
+ +### Angular < > + +Use to show file paths and navigation more clearly in applications. Add spaces before and after for enhanced readability except when followed by another punctuation mark. + +
+
+
    +
  • Open > Open file > Upload file > Save
    • +
+
+
+
    +
  • Open>Open file>Upload file>Save
    • +
+
+
+ +## Periods / full stops . + +Use consistently. We use full stops at the end of all full sentences and file extensions (.csv .txt .zip). + +
+
+
    +
  • Heading: No zones created
    • +
  • Description: Create zones from your dashboard.
    • +
+
+
+
    +
  • Heading: No notifications.
    • +
  • Description: We’ll notify you when there are updates or activities related to your account.
    • +
+
+
+ +When creating lists or using bullet points, use full stops for full sentences. If even one item in your list requires a full stop, add full stops to all items to keep punctuation consistent. + +
+
+
    +
  • List items:
    +   • Quick setup
    +   • Easy integration
    +   • 24/7 support
    • +
+
+
+
+
+
    +
  • List items:
    +   • Quick setup is available.
    +   • Easy integration with existing systems.
    +   • 24/7 support for all users.
    • +
+
+
+ +We do not use full stops for toast messages (brief pop-ups), headings, titles or icon/button text labels. No space before a full stop. Only one space after a full stop between sentences. + +
+
+
    +
  • Assets deleted (toast message)
    • +
  • Home (icon label)
    • +
+
+
+
    +
  • Assets deleted. (toast message)
    • +
  • Home. (icon label).
    • +
+
+
+ +## Question mark ? + +Question marks are appropriate for genuine informational questions, in help text and search prompts. However, avoid them in headings, even when phrased as questions, to maintain a confident and declarative tone. + +
+
+
    +
  • Need help? Contact support.
    • +
  • What are you looking for?
    • +
  • What’s new with Version 3.4?
    • +
+
+
+
    +
  • What's new with Version 3.4?
    • +
+
+ +State consequences clearly and use direct language that empowers users rather than questioning their choices. Avoid "Are you sure...?" phrasing specifically, as this can seem patronizing and undermines user confidence. + +
+
+
    +
  • Deleted users lose their access immediately.
    • +
+
+
+
    +
  • Are you sure you want to delete users?
    • +
+
-## Spacing +Never use multiple question marks for emphasis. Use one space after a question mark when it appears mid-sentence, and no space before. -- No space before % +
+
+
    +
  • Really???
    • +
  • Need help ?
    • +
+
+
-- No space before colon, semi-colon, ellipsis +## Quotation marks " " -- Add a space after colon or semi-colon +Use consistent quotation marks throughout the UI. We typically use straight double quotation marks, not single or curly, for direct quotes and to highlight UI text when it improves readability. Use quotation marks to differentiate UI elements only when the same word appears multiple times in close proximity or when clarity requires it. Avoid overusing quotation marks around UI elements as most of the time, the context is clear without them. -- Add a space before and after equation marks, hyphens and em dashes -- Add a space before unit of measurement +
+
+
    +
  • Select Save to apply a time zone
    • +
+
+
+
    +
  • Select "Save" to apply a time zone.
    • +
+
+
-
-
-
    -
  • 50%
    • -
  • 11am
    • -
  • Tuesday: no data
    • -
  • Browse…
    • -
+Never use quotation marks for emphasis or to add informal tone. No space between quotation marks and the enclosed text. One space after the closing quotation mark when mid-sentence. + +
+
+
    +
  • Customers said, and I quote, it was "a real gamechanger for the industry."
    • +
+
+
+
    +
  • This feature is "amazing" for productivity.
    • +
+
-
-
    -
  • 50 %
    • -
  • 11 am
    • -
  • Tuesday: no data
    • -
  • Browse …
    • -
+ +## Semi-colon ; + +Use semi-colons to separate key application features to enhance and contrast them, and to present steps or sequential information. We prefer using commas or short sentences instead as semi-colons are easily misused and misunderstood. No space before a semicolon. One space after a semicolon when mid-sentence. + +
+
+
    +
  • The system is offline; check your connection.
    • +
  • Our app offers real-time plant updates; personalized dashboards; and interactive maps.
    • +
  • Our app offers real-time plant updates, personalized dashboards and interactive maps.
    • +
  • 1. Calibrate sensors;
    2. Set operating parameters;
    3. Start the process.
    • +
+
+
+
    +
  • The system is offline ;check your connection.
    • +
  • The system is offline;check your connection.
    • +
+
+ +## Tilde ~ + +Use the tilde primarily in technical contexts to indicate approximation and home directories in file paths. In UI text, we prefer "approximately" or "about" for better clarity and accessibility when there is space within the UI. Add spaces before and after the tilde when using it to mean "approximately" in text. Remove spaces when used in file paths or technical notation. + +
+
+
    +
  • File path: ~/Documents/Projects
    • +
  • Processing time: ~ 5 minutes
    • +
  • Processing time: about 5 minutes
    • +
  • Temperature range: approximately 20–25°C
    • +
+
+
+
    +
  • File path: ~ / Documents / Projects
    • +
  • Processing time: ~5minutes
    • +
+
-## Lists +## Trademark symbols ™ ® -- Consistent use of full stops in lists / bullet points +Use the correct symbol for the correct context. ™ is used for unregistered trademarks, ® is used for registered trademarks. Always follow Siemens brand guidelines when applying trademark symbols to product and service names. -- If lists / points are not full sentences, do not use full stops +Only use the trademark symbol on the first mention of the name on a page or screen. Don't repeat it every time the name appears. -- Use fragments or full sentences in lists, not both +Never place a space between the name and the symbol. Don't alter the size or position of the symbol, it should always appear as a superscript. -- If a bullet / list item has two sentences, use full stops for this point and all others +
+
+
    +
  • BrandName™
    • +
  • BrandName®
    • +
+
+
+
    +
  • BrandName ™
    • +
  • BrandName ™®
    • +
+
+
+ +Note: If you are unsure whether a product name is a registered or unregistered trademark, check with your legal or brand team before publishing. Using the wrong symbol can have legal implications. -- Make lists parallel, i.e. all items / bullets have the same look, length, feel, punctuation, capitalization +## Punctuation and spacing -
+Spaces before punctuation: As a general rule, there are no spaces between text and its following punctuation. -
-
    -
  • Write comments
    • -
  • Respond to comments
    • -
  • Approve work orders
    • -
+
+
+
    +
  • The system, now fully updated, is ready to use.
    • +
+
+
+
    +
  • The system , now fully updated , is ready to use.
    • +
+
-
-
    -
  • Write comments
    • -
  • Respond to comments
    • -
  • Approve work orders by adding your fingerprint to your user management section in your smartphone.
    • -
+Spaces after punctuation: Use only one space after periods (full stops), commas, semicolons, colons, exclamation marks, question marks and quotation marks. + +
+
+
    +
  • Welcome to your new app experience. Log in to see more.
    • +
+
+
+
    +
  • Welcome to your new app experience.    Log in to see more.
    • +
+
+ +Spaces before and after punctuation: No spaces inside parentheses or quotation marks. + +
+
+
    +
  • Our new software version is here. Get ready for enhanced features (and a seamless user experience).
    • +
+
+
+
    +
  • Our new software version is here. Get ready for enhanced features ( and a seamless user experience ).
    • +
+
+ +## Related + +- [Messages overview](./messaging/messages-overview.md) +- [Progress updates](./messaging/progress-updates.mdx) diff --git a/docs/guidelines/language/support-and-resources/AI-and-UX-writing.md b/docs/guidelines/language/support-and-resources/AI-and-UX-writing.md index fa78c0f42..44b3ffc09 100644 --- a/docs/guidelines/language/support-and-resources/AI-and-UX-writing.md +++ b/docs/guidelines/language/support-and-resources/AI-and-UX-writing.md @@ -55,7 +55,7 @@ When presented with an error message, follow this process: * Error codes (unless user-facing standard) * Passive voice * Title casing, ALL CAP messages - * Blaming language (“you failed to...”) + * Blaming language (“you failed to…”) * “Please” do not use please for user actions or in any text 5. Include diff --git a/docs/guidelines/language/vocabulary.md b/docs/guidelines/language/vocabulary.md new file mode 100644 index 000000000..055cc0f78 --- /dev/null +++ b/docs/guidelines/language/vocabulary.md @@ -0,0 +1,560 @@ +--- +sidebar_position: 3 +sidebar_label: Vocabulary +title: Vocabulary +doc-type: 'banner' +component-tabs: [''] +no_single_tab: true +description: 'Explore common vocabulary themes and challenges in UX writing. This section guides you on using the correct and most effective words to create easily understandable content.' +--- + +## Word length + +Use short words instead of long words (8 letters or more) when possible. + +
+
+
    +
  • Start pump
    • +
  • Set flow rate
    • +
+
+
+
    +
  • Initialize hydraulic mechanism
    • +
  • Configure movement parameters
    • +
+
+
+ +Keep sentences under 25 words (the average is 15 words) and break up longer sentences. + +
+
+
    +
  • Pressure exceeds safe limits. Reduce flow rate immediately.
    • +
+
+
+
    +
  • The pressure monitoring system has detected levels that are significantly above the established safety thresholds and requires immediate corrective action.
    • +
+
+
+ +Keep headings, sub-headings, and email subjects under 65 characters (including spaces). + +
+
+
    +
  • Motor overheating alert
    • +
  • Pump maintenance required
    • +
  • Production line status
    • +
+
+
+
    +
  • Critical system malfunction detected - immediate maintenance required for production line
    • +
+
+
+ +## Modal verbs + +Modal verbs are helping words such as "can", "must" or "will". They are placed before other verbs to show possibility, permission, obligation or ability. We use some modal verbs in UI text when talking about what users can and cannot do in products. + +Use "can" and "cannot" to talk about permissions and capabilities instead of "could" that indicates uncertainty. + +
+
+
    +
  • You can export the data as CSV.
    • +
  • Failed to export. The system cannot export the data as CSV.
    • +
+
+
+
    +
  • You could export the data as CSV.
    • +
+
+
+ +Use "will" to talk about definite future actions and consequences instead of "would" that indicates hesitation and doubt. + +
+
+
    +
  • The system will send a confirmation email once updated.
    • +
+
+
+
    +
  • The system would send a confirmation email once updated.
    • +
+
+
+ +Do not use "should" when giving instructions as it indicates a recommendation, not a concrete action. + +
+
+
    +
  • Log in
    • +
+
+
+
    +
  • You should log in
    • +
+
+
+ +Specifically avoid using the modal verbs "may" or "might" as they are unclear. Instead, state consequences clearly. + +
+
+
    +
  • Removing this device influences any asset dependencies.
    • +
+
+
+
    +
  • Removing this device may influence asset dependencies.
    • +
+
+
+ +Avoid using "must" as this can seem aggressive and forceful. Only use it for emergencies. + +
+
+
    +
  • Enter your password.
    • +
  • All software must be updated by April 23, 2027, to avoid losing data.
    • +
+
+
+
    +
  • You must enter your password.
    • +
+
+
+ +Avoid "shall" as it sounds overly formal and legal, and readers often confuse it with "will" or "should". + +
+
+
    +
  • The system will delete these temporary files after 30 days.
    • +
+
+
+
    +
  • The system shall delete these temporary files after 30 days.
    • +
+
+
+ +## Idioms, buzzwords and jargon + +Avoid idiomatic expressions because their meaning cannot be understood literally from the words themselves, especially by non-native speakers. + +
+
+
    +
  • Resolve the issue by checking device connectivity.
    • +
+
+
+
    +
  • Nip this issue in the bud by checking device connectivity.
    • +
+
+
+ +Avoid buzzwords as they sound corporate rather than clear. + +
+
+
    +
  • Use this feature to personalize your notifications.
    • +
+
+
+
    +
  • Leverage this capability to personalize your notifications.
    • +
+
+
+ +Avoid jargon unless your specific audience understands the technical term better than a plain alternative. + +
+
+
    +
  • Save your changes automatically.
    • +
  • PLC configuration
    • +
  • motor speed
    • +
+
+
+
    +
  • Enable auto-persistence of data.
    • +
  • programmable logic controller setup
    • +
  • angular velocity coefficient
    • +
+
+
+ +Avoid cultural references or brand names unless functionally necessary. + +
+
+
    +
  • mobile device
    • +
  • search online
    • +
  • WLAN
    • +
+
+
+
    +
  • iPhone
    • +
  • Google
    • +
  • WiFi
    • +
+
+
+ +## Phrasal verbs (multi-word verbs) + +Avoid multi-word phrasal verbs when one word works. + +
+
+
    +
  • calculate
    • +
  • continue
    • +
  • delete
    • +
  • review alarm history
    • +
+
+
+
    +
  • add up
    • +
  • carry on
    • +
  • get rid of
    • +
  • look over alarm history
    • +
+
+
+ +Use common industrial-application phrasal verbs when they are more familiar than one-word alternatives. + +
+
+
    +
  • log out
    • +
  • shut down
    • +
  • start up
    • +
+
+
+
    +
  • terminate
    • +
  • deactivate
    • +
  • initiate
    • +
+
+
+ +## Abbreviations and acronyms + +Use abbreviations and acronyms carefully. They can improve clarity for domain users, but can confuse general users. Never invent your own acronyms. Use established terminology only. See [Capitalization and proper nouns](./capitalization-and-proper-nouns) for punctuation guidance. + +
+
+
    +
  • Acknowledge
    • +
+
+
+
    +
  • Ack
    • +
  • Akdg
    • +
+
+
+ +Avoid Latin abbreviations when there is space in the UI for plain English alternatives. Although e.g. and i.e. seem to be universally understood, many non-native English speakers cannot distinguish between them. + +
+
+
    +
  • for example
    • +
  • for instance
    • +
  • that is
    • +
  • specifically
    • +
  • and so on
    • +
+
+
+
    +
  • e.g.
    • +
  • i.e.
    • +
  • etc.
    • +
+
+
+ +Use established industry-standard acronyms when your user expects them. Spell out new or less familiar acronyms on first use, then use the acronym consistently afterward. + +
+
+
    +
  • PLC configuration
    • +
  • USB connection
    • +
  • Access the Supervisory Control and Data Acquisition (SCADA) dashboard to view production metrics. Update SCADA alarm thresholds as needed.
    • +
+
+
+
    +
  • Programmable Logic Controller (PLC) configuration
    • +
  • Universal Serial Bus connection
    • +
  • Access the SCADA dashboard to view production metrics. Update SCADA alarm thresholds as needed.
    • +
+
+
+ +Abbreviations are acceptable in buttons, labels and tables when space is limited and only when they are familiar to users. Clarify abbreviations in a visible part of the UI with legends, glossaries or infotips. + +
+
+
    +
  • Max
    • +
  • Min
    • +
  • Temp
    • +
  • Info
    • +
+
+
+ +Add lower case "s" without an apostrophe for plural forms. + +
+
+
    +
  • PLCs
    • +
  • APIs
    • +
+
+
+
    +
  • PLC's
    • +
  • API's
    • +
+
+
+ +## Nouns without plural form + +English has many nouns that do not take a plural form (they do not use "s" for plurals). These are common errors in menus, labels and instructions within industrial UIs. + +
+
+
    +
  • feedback
    • +
  • additional feedback
    • +
  • information
    • +
  • more information
    • +
  • equipment
    • +
  • navigation
    • +
  • progress
    • +
  • data
    • +
  • software
    • +
+
+
+
    +
  • feedbacks
    • +
  • informations
    • +
  • equipments
    • +
  • navigations
    • +
  • progresses
    • +
  • datas
    • +
  • softwares
    • +
+
+
+ +Use the singular verb form for collective nouns. Organizations and groups are single entities. + +
+
+
    +
  • Siemens provides industrial automation solutions.
    • +
  • The team is reviewing the configuration.
    • +
  • The company has released a new update.
    • +
+
+
+
    +
  • Siemens provide industrial automation solutions.
    • +
  • The team are reviewing the configuration.
    • +
  • The company have released a new update.
    • +
+
+
+ +## Time-based vocabulary + +Choose time-related words carefully. They set user expectations about whether more updates, events or actions will occur. + +### Last vs. latest vs. recent + +Last implies nothing else will follow. It is final and no more are coming. + +
+
+
    +
  • Last update (final)
    • +
+
+
+
    +
  • Last update (ongoing)
    • +
+
+
+ +Latest is the most recent and newest, which means there could be more to follow. + +
+
+
    +
  • Latest summary (more coming)
    • +
+
+
+
    +
  • Latest summary (final – no more coming)
    • +
+
+
+ +Recent means it happened a short time ago. Similar to "latest" but highlights events closer to the present. + +
+
+
    +
  • Recent events (happened recently)
    • +
+
+
+
    +
  • Recent events (happened a long time ago)
    • +
+
+
+ +### Pending vs. waiting vs. queued + +Pending means waiting for an action or decision that needs someone else to act. + +
+
+
    +
  • Pending approval
    • +
+
+
+ +Waiting means the system is paused until a condition is met. Avoid "awaiting" as this is too formal. + +
+
+
    +
  • Waiting for connection.
    • +
  • Waiting for sensor response.
    • +
+
+
+
    +
  • Awaiting sensor response.
    • +
+
+
+ +Queued means something is in a line and will be processed in order. + +
+
+
    +
  • Queued jobs
    • +
+
+
+
    +
  • Waiting jobs
    • +
+
+
+ +## False friends + +False friends are words that seem correct because they look similar to words in other languages, but they mean something different in English. Always check the English meaning and avoid word-for-word translations. + +Here are common false friends in industrial UX writing. + +| English word and meaning | Similar to other language | Meaning in other language | Typical error in UX writing | Correct translation | +| --- | --- | --- | --- | --- | +| actual (real) | German "aktuell" | current, present | "actual value" read as "current value" not "real value" | "tatsächlich" (actual)
"aktuell" (current) | +| actualize (make real) | German "aktualisieren" | update, refresh | "actualize notifications" read as "update notifications" not "make notifications real" | "aktualisieren" (update)
"verwirklichen" (actualize) | +| billion (109) | German "Billion" | trillion (1012) | data values off by 1000x in reports | "Milliarde" (billion)
"Billion" (trillion) | +| control (regulate) | Spanish "controlar" | to check, verify | "control system" might mean "check system" | "Gestionar/administrar un proceso" (control the process)
"Panel de configuracion/supervision" (control panel) | +| date (day/time) | German "Datei" | computer file | "enter date" could mean "enter file" | "Datum" (date)
"Datei" (file) | +| eventually (in time) | German "eventuell" | possibly, perhaps | "process eventually completes" is ambiguous | "schließlich" (eventually)
"eventuell" (possibly) | +| exit (leave) | Spanish "exito" | success | "exit code" could mean "success code" | "salida" (exit)
"éxito" (success) | +| fabric (textile) | French "fabrique" | factory, plant | "fabric configuration" suggests factory config | "tissu" (fabric)
"fabrique" (factory) | +| fast (quick) | German "fast" | almost, nearly | "fast mode" means "almost mode" | "schnell" (fast)
"fast" (almost) | +| large (big) | French "large" | wide | "large capacity" might mean "wide capacity" | "grand" (large)
"large" (wide) | +| library (collection) | French "librairie" | bookstore | "code library" misunderstood | "bibliothèque" (library)
"librairie" (bookstore) | +| realize (understand) | Spanish "realizar" | to carry out, perform | "realize changes" means "perform changes" | "darse cuenta" (realize)
"realizar" (perform) | +| sensible (rational) | French "sensible" | sensitive | "sensible data" means sensitive, not reasonable | "raisonnable" (sensible)
"sensible" (sensitive) | + +## Common wording issues + +The following words and pairs are often misused and misunderstood when writing text for industrial applications. + +
+
+
    +
  • Error state (fixed condition)
    • +
  • Status: Running (ongoing process)
    • +
  • in the future
    • +
  • on Monday
    • +
  • time zone
    • +
  • log file (two words)
    • +
  • log in (as an action)
    • +
  • login (as a noun)
    • +
  • 34 million
    • +
+
+
+
    +
  • Error status
    • +
  • State: Running
    • +
  • in future
    • +
  • on the Monday
    • +
  • timezone
    • +
  • logfile
    • +
  • login (as an action)
    • +
  • log in (as a noun)
    • +
  • 34 millions
    • +
+
+
+ +## Related + +- [UI terminology](./menu-functions-and-ui-labels/ui-terminology) +- [Grammar and vocabulary](./grammar-and-vocabulary) diff --git a/docs/home/support/faq.md b/docs/home/support/faq.md index 407170b4a..f426da394 100644 --- a/docs/home/support/faq.md +++ b/docs/home/support/faq.md @@ -5,7 +5,7 @@ title: FAQ doc-type: 'banner' component-tabs: [''] no_single_tab: true -description: 'Welcome to the Industrial Experience design system FAQ. These are your go-to resource for quick and clear answers about Industrial Experience. Whether you’re just starting with the design system or need insights into integration and functionality, you’ll find answers to the most common questions here. If you can’t find what you’re looking for, feel free to reach out. The FAQ are continuously updated, and we welcome suggestions for improvement via email to our support team. Thank you for choosing to use Siemens Industrial Experience.' +description: 'Find quick answers about Industrial Experience, including setup, integration, customization and support. This FAQ is regularly updated with common questions and guidance.' --- import Accordion from '@site/src/components/Accordion'; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7d7ccd1c4..67c7e22b3 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -851,8 +851,8 @@ packages: resolution: {integrity: sha512-909rVuj3phpjW6y0MCXAZ5iNeORePa6ldJvp2baWGcTjwqbBDDz6xoS5JHJ7lS88NlwLYj07ImL/8IUMtDZzTA==} engines: {node: '>=6.9.0'} - '@babel/runtime@7.28.6': - resolution: {integrity: sha512-05WQkdpL9COIMz4LjTxGpPNCdlpyimKppYNoJ5Di5EUObifl8t4tuLuUBBZEpoLYOmfvIWrsp9fCl0HoPRVTdA==} + '@babel/runtime@7.29.7': + resolution: {integrity: sha512-Nq8OhGWiZIZGV6hLHoyAKLLcJihP/xFeBMGJoUrxTX2psI8dCifzLhZISFb+VWS3wFMRDmCGw5R+dOySCqPLhw==} engines: {node: '>=6.9.0'} '@babel/template@7.27.2': @@ -1752,92 +1752,86 @@ packages: resolution: {integrity: sha512-5Kva+/Gi7c+39d0/0MM/v/5RCZuwqm75fUD+t7Es3Iz/adui54GnjfNmJpkkPkXGC+5IWnEvgqwY6gstK/JlUQ==} engines: {node: '>= 18'} - '@parcel/watcher-android-arm64@2.5.6': - resolution: {integrity: sha512-YQxSS34tPF/6ZG7r/Ih9xy+kP/WwediEUsqmtf0cuCV5TPPKw/PQHRhueUo6JdeFJaqV3pyjm0GdYjZotbRt/A==} + '@parcel/watcher-android-arm64@2.6.0': + resolution: {integrity: sha512-trgpLSCKRC/huFjXX/Smh+0sWe4+YtKfktIToiMl59ghz7z+qkH6kMvNnUbLyRs9N11t8l4svSCs1+5B3rOAhA==} engines: {node: '>= 10.0.0'} cpu: [arm64] os: [android] - '@parcel/watcher-darwin-arm64@2.5.6': - resolution: {integrity: sha512-Z2ZdrnwyXvvvdtRHLmM4knydIdU9adO3D4n/0cVipF3rRiwP+3/sfzpAwA/qKFL6i1ModaabkU7IbpeMBgiVEA==} + '@parcel/watcher-darwin-arm64@2.6.0': + resolution: {integrity: sha512-Y3QV0gl7Q1zbfueunkWIERICbEojQFCgpyG7YqOGNFLsckXyI1xu9mAIUpKY9QBYzBtSkN8dBPwd3yiAO9ovMw==} engines: {node: '>= 10.0.0'} cpu: [arm64] os: [darwin] - '@parcel/watcher-darwin-x64@2.5.6': - resolution: {integrity: sha512-HgvOf3W9dhithcwOWX9uDZyn1lW9R+7tPZ4sug+NGrGIo4Rk1hAXLEbcH1TQSqxts0NYXXlOWqVpvS1SFS4fRg==} + '@parcel/watcher-darwin-x64@2.6.0': + resolution: {integrity: sha512-Ohv6OpzhUfKYD7Beb8kDvG0jbIxORCYY1JRdZnaBtnjjkJxgD7ZVL0nw2sCYd0yTMKTvz3nnTnOF3cDifK+kvw==} engines: {node: '>= 10.0.0'} cpu: [x64] os: [darwin] - '@parcel/watcher-freebsd-x64@2.5.6': - resolution: {integrity: sha512-vJVi8yd/qzJxEKHkeemh7w3YAn6RJCtYlE4HPMoVnCpIXEzSrxErBW5SJBgKLbXU3WdIpkjBTeUNtyBVn8TRng==} + '@parcel/watcher-freebsd-x64@2.6.0': + resolution: {integrity: sha512-5HmXvDgs8VK+74jF9y9/2FE3/OnlcKmc56tjmSrEuZjpSZOGL+fvAu+HKJBdPs9uwoP2hE6TlSUpXZ/C5jUFmQ==} engines: {node: '>= 10.0.0'} cpu: [x64] os: [freebsd] - '@parcel/watcher-linux-arm-glibc@2.5.6': - resolution: {integrity: sha512-9JiYfB6h6BgV50CCfasfLf/uvOcJskMSwcdH1PHH9rvS1IrNy8zad6IUVPVUfmXr+u+Km9IxcfMLzgdOudz9EQ==} + '@parcel/watcher-linux-arm-glibc@2.6.0': + resolution: {integrity: sha512-Ps/hui3A+vMbjdqlqAowK2ZL8+BO8dBjxeWXj6npTBs3jx4wWmbPpaLuqwrQrSqIVMCnpWo238bJ1U37GhQOYg==} engines: {node: '>= 10.0.0'} cpu: [arm] os: [linux] libc: [glibc] - '@parcel/watcher-linux-arm-musl@2.5.6': - resolution: {integrity: sha512-Ve3gUCG57nuUUSyjBq/MAM0CzArtuIOxsBdQ+ftz6ho8n7s1i9E1Nmk/xmP323r2YL0SONs1EuwqBp2u1k5fxg==} + '@parcel/watcher-linux-arm-musl@2.6.0': + resolution: {integrity: sha512-9c6AUHgHoG+IY88MRIHupztQiQnrbqHYQjkM2btA+Bf/wQnQMuiD0Wfk1EVv3TlNT3x41uU71rn6E4xh/+zvkw==} engines: {node: '>= 10.0.0'} cpu: [arm] os: [linux] libc: [musl] - '@parcel/watcher-linux-arm64-glibc@2.5.6': - resolution: {integrity: sha512-f2g/DT3NhGPdBmMWYoxixqYr3v/UXcmLOYy16Bx0TM20Tchduwr4EaCbmxh1321TABqPGDpS8D/ggOTaljijOA==} + '@parcel/watcher-linux-arm64-glibc@2.6.0': + resolution: {integrity: sha512-yHRqS2owEXe6Hic9z6Mh1ECsCd+ODVOGvZDyciqRd21+v+o+DnXMOrw50DSpIG2sb8GPEaPPmfeCAWKPJdq46g==} engines: {node: '>= 10.0.0'} cpu: [arm64] os: [linux] libc: [glibc] - '@parcel/watcher-linux-arm64-musl@2.5.6': - resolution: {integrity: sha512-qb6naMDGlbCwdhLj6hgoVKJl2odL34z2sqkC7Z6kzir8b5W65WYDpLB6R06KabvZdgoHI/zxke4b3zR0wAbDTA==} + '@parcel/watcher-linux-arm64-musl@2.6.0': + resolution: {integrity: sha512-WhB2e/V7rqdHHWZusBSPuy5Ei8S6lSz6FE5TKKQz5h3a0O+C+mhY7vxU9b/stqvMb8beLnPY82ZrFTLKs+SrKA==} engines: {node: '>= 10.0.0'} cpu: [arm64] os: [linux] libc: [musl] - '@parcel/watcher-linux-x64-glibc@2.5.6': - resolution: {integrity: sha512-kbT5wvNQlx7NaGjzPFu8nVIW1rWqV780O7ZtkjuWaPUgpv2NMFpjYERVi0UYj1msZNyCzGlaCWEtzc+exjMGbQ==} + '@parcel/watcher-linux-x64-glibc@2.6.0': + resolution: {integrity: sha512-ulGE6x6Oz6iAwg75T8YQSoguBWasniIbX+QWpaYPcCnDOpdWX3k+4xbEYPZVLxOuoJI+svJJPD3sEj8G7lrQ3A==} engines: {node: '>= 10.0.0'} cpu: [x64] os: [linux] libc: [glibc] - '@parcel/watcher-linux-x64-musl@2.5.6': - resolution: {integrity: sha512-1JRFeC+h7RdXwldHzTsmdtYR/Ku8SylLgTU/reMuqdVD7CtLwf0VR1FqeprZ0eHQkO0vqsbvFLXUmYm/uNKJBg==} + '@parcel/watcher-linux-x64-musl@2.6.0': + resolution: {integrity: sha512-tkBYKt7YQrjIJWYDnto2YgO8MRkjlMTSNoRHzsXinBqbLdeOM3L32wPZJvIZxqaLMfSlS/4sUjH/6STVP/XDLw==} engines: {node: '>= 10.0.0'} cpu: [x64] os: [linux] libc: [musl] - '@parcel/watcher-win32-arm64@2.5.6': - resolution: {integrity: sha512-3ukyebjc6eGlw9yRt678DxVF7rjXatWiHvTXqphZLvo7aC5NdEgFufVwjFfY51ijYEWpXbqF5jtrK275z52D4Q==} + '@parcel/watcher-win32-arm64@2.6.0': + resolution: {integrity: sha512-gIZAP23jaHjGWasY/TY6yL7NHFClf0Ga7FN+iINvk+KN94rhm94lYZhFsbYFNcA04/onvGD9kKmiJLJB2HbNwQ==} engines: {node: '>= 10.0.0'} cpu: [arm64] os: [win32] - '@parcel/watcher-win32-ia32@2.5.6': - resolution: {integrity: sha512-k35yLp1ZMwwee3Ez/pxBi5cf4AoBKYXj00CZ80jUz5h8prpiaQsiRPKQMxoLstNuqe2vR4RNPEAEcjEFzhEz/g==} - engines: {node: '>= 10.0.0'} - cpu: [ia32] - os: [win32] - - '@parcel/watcher-win32-x64@2.5.6': - resolution: {integrity: sha512-hbQlYcCq5dlAX9Qx+kFb0FHue6vbjlf0FrNzSKdYK2APUf7tGfGxQCk2ihEREmbR6ZMc0MVAD5RIX/41gpUzTw==} + '@parcel/watcher-win32-x64@2.6.0': + resolution: {integrity: sha512-cA+/pXV2YkfxlIcXOQ5fSWqAzzPyD78/x5qbK/I0vUkrlYHA8TIz+MXjAbGouguKVSI4bOmkTSJ1/poVSsgt+A==} engines: {node: '>= 10.0.0'} cpu: [x64] os: [win32] - '@parcel/watcher@2.5.6': - resolution: {integrity: sha512-tmmZ3lQxAe/k/+rNnXQRawJ4NjxO2hqiOLTHvWchtGZULp4RyFeh6aU4XdOYBFe2KE1oShQTv4AblOs2iOrNnQ==} + '@parcel/watcher@2.6.0': + resolution: {integrity: sha512-7FNeNl8NCE7aINx7WXiKQrPYZWC/hvrTsmk6zmxbI7LTXE7hVek/n8AfVgpe2y82zl3w0HvCHN0bVKMBoJcC0w==} engines: {node: '>= 10.0.0'} '@pkgjs/parseargs@0.11.0': @@ -2551,8 +2545,8 @@ packages: caniuse-api@3.0.0: resolution: {integrity: sha512-bsTwuIg/BZZK/vreVTYYbSWoe2F+71P7K5QGEX+pT250DZbfU1MQ5prOKpPR+LL6uWKK3KMwMCAS74QB3Um1uw==} - caniuse-lite@1.0.30001718: - resolution: {integrity: sha512-AflseV1ahcSunK53NfEs9gFWgOEmzr0f+kaMFA4xiLZlr9Hzt7HxcSpIFcnNCUkz6R6dWKa54rUz3HUmI3nVcw==} + caniuse-lite@1.0.30001806: + resolution: {integrity: sha512-72Cuvd95zbSYPKq6Fhg8eDJRlzgWDf7/mtoZv6Qe/DYNCEBdNxoA3+rZAU2ZhGCpZlns3EssFavaZomckT5Uuw==} ccount@2.0.1: resolution: {integrity: sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==} @@ -3730,8 +3724,8 @@ packages: immer@9.0.21: resolution: {integrity: sha512-bc4NBHqOqSfRW7POMkHd51LvClaeMXpm8dx0e8oE2GORbq5aRK7Bxl4FyzVLdGtLmvLKL7BTDBG5ACQm4HWjTA==} - immutable@5.1.4: - resolution: {integrity: sha512-p6u1bG3YSnINT5RQmx/yRZBpenIl30kVxkTLDyHLIMk0gict704Q9n+thfDI7lTRm9vXdDYutVzXhzcThxTnXA==} + immutable@5.1.9: + resolution: {integrity: sha512-m8nVez3rwrgmWxtLMt1ZYXB2Lv7OKYn/disyxAlSDYAlKSlFoPPfIAmAM/M5xqL4m4C/wAPw7S2/CNaUii1Hxg==} import-fresh@3.3.1: resolution: {integrity: sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==} @@ -4668,6 +4662,10 @@ packages: resolution: {integrity: sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==} engines: {node: '>=12'} + picomatch@4.0.5: + resolution: {integrity: sha512-RvwwcruNjI1ncT5xRakeyS9Lf8lcItv34KD+aif+VH9kduAyfYBipGh12274xtenIPZ119/R9BdTBa8gAwSh0A==} + engines: {node: '>=12'} + pify@2.3.0: resolution: {integrity: sha512-udgsAY+fTnvv7kI7aaxbqwWNb0AHiB0qBO89PZKPkoTmGOgdbrHDKD+0B2X4uTfJ/FT1R09r9gTsjUjNJotuog==} engines: {node: '>=0.10.0'} @@ -7117,7 +7115,7 @@ snapshots: dependencies: core-js-pure: 3.42.0 - '@babel/runtime@7.28.6': {} + '@babel/runtime@7.29.7': {} '@babel/template@7.27.2': dependencies: @@ -7439,7 +7437,7 @@ snapshots: '@babel/preset-env': 7.27.2(@babel/core@7.27.1) '@babel/preset-react': 7.27.1(@babel/core@7.27.1) '@babel/preset-typescript': 7.27.1(@babel/core@7.27.1) - '@babel/runtime': 7.28.6 + '@babel/runtime': 7.29.7 '@babel/runtime-corejs3': 7.27.1 '@babel/traverse': 7.27.1 '@docusaurus/logger': 3.7.0 @@ -8671,65 +8669,61 @@ snapshots: '@octokit/request-error': 6.1.8 '@octokit/webhooks-methods': 5.1.1 - '@parcel/watcher-android-arm64@2.5.6': + '@parcel/watcher-android-arm64@2.6.0': optional: true - '@parcel/watcher-darwin-arm64@2.5.6': + '@parcel/watcher-darwin-arm64@2.6.0': optional: true - '@parcel/watcher-darwin-x64@2.5.6': + '@parcel/watcher-darwin-x64@2.6.0': optional: true - '@parcel/watcher-freebsd-x64@2.5.6': + '@parcel/watcher-freebsd-x64@2.6.0': optional: true - '@parcel/watcher-linux-arm-glibc@2.5.6': + '@parcel/watcher-linux-arm-glibc@2.6.0': optional: true - '@parcel/watcher-linux-arm-musl@2.5.6': + '@parcel/watcher-linux-arm-musl@2.6.0': optional: true - '@parcel/watcher-linux-arm64-glibc@2.5.6': + '@parcel/watcher-linux-arm64-glibc@2.6.0': optional: true - '@parcel/watcher-linux-arm64-musl@2.5.6': + '@parcel/watcher-linux-arm64-musl@2.6.0': optional: true - '@parcel/watcher-linux-x64-glibc@2.5.6': + '@parcel/watcher-linux-x64-glibc@2.6.0': optional: true - '@parcel/watcher-linux-x64-musl@2.5.6': + '@parcel/watcher-linux-x64-musl@2.6.0': optional: true - '@parcel/watcher-win32-arm64@2.5.6': + '@parcel/watcher-win32-arm64@2.6.0': optional: true - '@parcel/watcher-win32-ia32@2.5.6': + '@parcel/watcher-win32-x64@2.6.0': optional: true - '@parcel/watcher-win32-x64@2.5.6': - optional: true - - '@parcel/watcher@2.5.6': + '@parcel/watcher@2.6.0': dependencies: detect-libc: 2.1.2 is-glob: 4.0.3 node-addon-api: 7.1.1 - picomatch: 4.0.3 + picomatch: 4.0.5 optionalDependencies: - '@parcel/watcher-android-arm64': 2.5.6 - '@parcel/watcher-darwin-arm64': 2.5.6 - '@parcel/watcher-darwin-x64': 2.5.6 - '@parcel/watcher-freebsd-x64': 2.5.6 - '@parcel/watcher-linux-arm-glibc': 2.5.6 - '@parcel/watcher-linux-arm-musl': 2.5.6 - '@parcel/watcher-linux-arm64-glibc': 2.5.6 - '@parcel/watcher-linux-arm64-musl': 2.5.6 - '@parcel/watcher-linux-x64-glibc': 2.5.6 - '@parcel/watcher-linux-x64-musl': 2.5.6 - '@parcel/watcher-win32-arm64': 2.5.6 - '@parcel/watcher-win32-ia32': 2.5.6 - '@parcel/watcher-win32-x64': 2.5.6 + '@parcel/watcher-android-arm64': 2.6.0 + '@parcel/watcher-darwin-arm64': 2.6.0 + '@parcel/watcher-darwin-x64': 2.6.0 + '@parcel/watcher-freebsd-x64': 2.6.0 + '@parcel/watcher-linux-arm-glibc': 2.6.0 + '@parcel/watcher-linux-arm-musl': 2.6.0 + '@parcel/watcher-linux-arm64-glibc': 2.6.0 + '@parcel/watcher-linux-arm64-musl': 2.6.0 + '@parcel/watcher-linux-x64-glibc': 2.6.0 + '@parcel/watcher-linux-x64-musl': 2.6.0 + '@parcel/watcher-win32-arm64': 2.6.0 + '@parcel/watcher-win32-x64': 2.6.0 optional: true '@pkgjs/parseargs@0.11.0': @@ -8810,7 +8804,7 @@ snapshots: '@slorber/react-helmet-async@1.3.0(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: - '@babel/runtime': 7.28.6 + '@babel/runtime': 7.29.7 invariant: 2.2.4 prop-types: 15.8.1 react: 18.3.1 @@ -9379,7 +9373,7 @@ snapshots: autoprefixer@10.4.21(postcss@8.5.3): dependencies: browserslist: 4.24.5 - caniuse-lite: 1.0.30001718 + caniuse-lite: 1.0.30001806 fraction.js: 4.3.7 normalize-range: 0.1.2 picocolors: 1.1.1 @@ -9506,7 +9500,7 @@ snapshots: browserslist@4.24.5: dependencies: - caniuse-lite: 1.0.30001718 + caniuse-lite: 1.0.30001806 electron-to-chromium: 1.5.155 node-releases: 2.0.19 update-browserslist-db: 1.1.3(browserslist@4.24.5) @@ -9562,11 +9556,11 @@ snapshots: caniuse-api@3.0.0: dependencies: browserslist: 4.24.5 - caniuse-lite: 1.0.30001718 + caniuse-lite: 1.0.30001806 lodash.memoize: 4.1.2 lodash.uniq: 4.5.0 - caniuse-lite@1.0.30001718: {} + caniuse-lite@1.0.30001806: {} ccount@2.0.1: {} @@ -10757,7 +10751,7 @@ snapshots: history@4.10.1: dependencies: - '@babel/runtime': 7.28.6 + '@babel/runtime': 7.29.7 loose-envify: 1.4.0 resolve-pathname: 3.0.0 tiny-invariant: 1.3.3 @@ -10917,7 +10911,7 @@ snapshots: immer@9.0.21: {} - immutable@5.1.4: {} + immutable@5.1.9: {} import-fresh@3.3.1: dependencies: @@ -12033,6 +12027,9 @@ snapshots: picomatch@4.0.3: {} + picomatch@4.0.5: + optional: true + pify@2.3.0: {} pirates@4.0.7: {} @@ -12637,7 +12634,7 @@ snapshots: react-loadable-ssr-addon-v5-slorber@1.0.1(@docusaurus/react-loadable@6.0.0(react@18.3.1))(webpack@5.99.8): dependencies: - '@babel/runtime': 7.28.6 + '@babel/runtime': 7.29.7 react-loadable: '@docusaurus/react-loadable@6.0.0(react@18.3.1)' webpack: 5.99.8 @@ -12663,13 +12660,13 @@ snapshots: react-router-config@5.1.1(react-router@5.3.4(react@18.3.1))(react@18.3.1): dependencies: - '@babel/runtime': 7.28.6 + '@babel/runtime': 7.29.7 react: 18.3.1 react-router: 5.3.4(react@18.3.1) react-router-dom@5.3.4(react@18.3.1): dependencies: - '@babel/runtime': 7.28.6 + '@babel/runtime': 7.29.7 history: 4.10.1 loose-envify: 1.4.0 prop-types: 15.8.1 @@ -12680,7 +12677,7 @@ snapshots: react-router@5.3.4(react@18.3.1): dependencies: - '@babel/runtime': 7.28.6 + '@babel/runtime': 7.29.7 history: 4.10.1 hoist-non-react-statics: 3.3.2 loose-envify: 1.4.0 @@ -12951,10 +12948,10 @@ snapshots: sass@1.87.0: dependencies: chokidar: 4.0.3 - immutable: 5.1.4 + immutable: 5.1.9 source-map-js: 1.2.1 optionalDependencies: - '@parcel/watcher': 2.5.6 + '@parcel/watcher': 2.6.0 sax@1.4.1: {}