diff --git a/docs/guidelines/language/dialogs-and-buttons.md b/docs/guidelines/language/dialogs-and-buttons.md index 29000256..75b6a235 100644 --- a/docs/guidelines/language/dialogs-and-buttons.md +++ b/docs/guidelines/language/dialogs-and-buttons.md @@ -1,5 +1,5 @@ --- -sidebar_position: 10 +sidebar_position: 9 sidebar_label: Dialogs and buttons title: Dialogs and buttons doc-type: 'banner' diff --git a/docs/guidelines/language/frequent-app-functions.md b/docs/guidelines/language/frequent-app-functions.md index f8c2421f..7b1b6dcd 100644 --- a/docs/guidelines/language/frequent-app-functions.md +++ b/docs/guidelines/language/frequent-app-functions.md @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 8 sidebar_label: Frequent app functions title: Frequent app functions doc-type: 'banner' diff --git a/docs/guidelines/language/main-menu-functions.md b/docs/guidelines/language/main-menu-functions.md deleted file mode 100644 index 95066498..00000000 --- a/docs/guidelines/language/main-menu-functions.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -sidebar_position: 8 -sidebar_label: Main menu functions and labels -title: Main menu functions and labels -doc-type: 'banner' -component-tabs: [''] -no_single_tab: true -description: 'Explore best practices for writing main menu functions to ensure intuitive navigation. This section provides tips on how to label and organize menu items so users can easily find what they need.' ---- - -# - -## Welcome page - -- Username or email - -- Log in - -- Forgot password? - -
-
- -- Sign in / Sign up -- Login (as it is a noun, not a verb) - -
-
- -## User management - -- Username - -- Profile / User profile - -- Account - -- ID - -- Email address - -- Last name - -- First name - -- Add user / Delete user - -- Add permissions / Revoke permissions / Edit permissions - -- Edit account - -
-
- -- id / identification -- E-mail -- Add a user / Delete a user / Add permission -- Surname / Initial name / Given name - -
-
- -## Roles - -- User - -- Read-only user - -- Technical - -- Expert - -- Admin - -- Administrator - -## Password - -- Change password - -- Current password - -- New password - -- Repeat new password - -## License management - -- Used licenses - -- Free licenses - -- Available licenses - -### License status - -- License start / License end - -- Purchased licenses - -- License type - -- Activated licenses - -- Used licenses - -- Expired licenses - -
-
- -- licence - -
-
- -## About & legal information - -- General information - -- OSS readme - -- Corporate information - -- Privacy notice - -- Version 1.0 - -- Terms of use - -- Acceptable use policy - -- Privacy policy - -- Copyright policy - -- Cookie notice - -- Digital ID - -- © Siemens AG 20XX - -
-
- -- V1 - -
-
- -## Service & Support - -- Contact Service & Support: support@mail.com - -- Feedback: What do you think of our app? - -- Manual - -- FAQ - -
-
- -- Documentation -- User manual - -
-
- -## Workspace - -- Application status - -- KPI settings - -- KPIs - -
-
- -- KPI's settings -- KPIS settings - -
-
- -## Resetting - -- Factory reset - -- Please wait until [application] is reset… diff --git a/docs/guidelines/language/menu-functions-and-ui-labels/logging-in-and-out.md b/docs/guidelines/language/menu-functions-and-ui-labels/logging-in-and-out.md index daa263f5..a3e3b22b 100644 --- a/docs/guidelines/language/menu-functions-and-ui-labels/logging-in-and-out.md +++ b/docs/guidelines/language/menu-functions-and-ui-labels/logging-in-and-out.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 1 sidebar_label: Logging in and out title: Logging in and out doc-type: 'banner' diff --git a/docs/guidelines/language/menu-functions-and-ui-labels/onboarding.md b/docs/guidelines/language/menu-functions-and-ui-labels/onboarding.md index 503ac0ea..810bcf8c 100644 --- a/docs/guidelines/language/menu-functions-and-ui-labels/onboarding.md +++ b/docs/guidelines/language/menu-functions-and-ui-labels/onboarding.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 sidebar_label: Onboarding title: Onboarding doc-type: 'banner' diff --git a/docs/guidelines/language/messaging/_category_.json b/docs/guidelines/language/messaging/_category_.json index 81d9ff64..ba46be5b 100644 --- a/docs/guidelines/language/messaging/_category_.json +++ b/docs/guidelines/language/messaging/_category_.json @@ -1,4 +1,4 @@ { - "label": "Messaging", + "label": "Messages", "position": 5 } diff --git a/docs/guidelines/language/writing-style-guide-getting-started.md b/docs/guidelines/language/writing-style-guide-getting-started.md index 4d4ef5eb..a5876613 100644 --- a/docs/guidelines/language/writing-style-guide-getting-started.md +++ b/docs/guidelines/language/writing-style-guide-getting-started.md @@ -30,10 +30,10 @@ Learn the guidelines for using proper nouns correctly in your text. This subchap Discover how we address formatting themes such as writing addresses, dates, measurements and units, names and titles, and money and currency. This section helps you address common formatting wording issues to enhance overall user efficiency. [Read more]( ./formatting/addresses.mdx) +## Menu functions and UI labels -## Main menu functions +Explore best practices for writing common menu functions, e.g. logging in and welcoming and onboarding users. This section also includes how to label common UI labels, e.g. buttons, so users can easily navigate workflows. [Read more](./menu-functions-and-ui-labels/logging-in-and-out.md) -Explore best practices for writing main menu functions to ensure intuitive navigation. This section provides tips on how to label and organize menu items so users can easily find what they need. [Read more](./main-menu-functions) ## Messages @@ -47,3 +47,7 @@ Get tips for naming common app functions clearly and effectively. This subchapte ## Dialogs and buttons Discover guidelines for writing dialogs and button labels to ensure clear and actionable instructions. This section helps you create effective prompts and calls to action that enhance user interaction. [Read more](./dialogs-and-buttons) + +## Support and resources + +Learn about the UX writer role, how writers work in teams and with stakeholders, and explore the UX writing library and AI resources to build your UX writing skills. [Read more](./support-and-resources/UX-writing-principles.md)