Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Adjust the order of Menu Items on Foundations #946

Merged
merged 2 commits into from
Nov 6, 2024
Merged

docs: Adjust the order of Menu Items on Foundations #946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0125bb
docs: Adjust the order of Menu Items on Foundations
BenniEngel Nov 5, 2024
cddb20e
docs: cleanup do and don't empty components
BenniEngel Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .../design/design-tokens/examples/schema.tsx → ...sign/01-design-tokens/examples/schema.tsx
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions ...oundations/design/design-tokens/index.mdx → ...ions/01-design/01-design-tokens/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Design Tokens
---

Design Tokens übersetzen grundlegende Designentscheidungen wie Farben, Abstände
und mehr in eine einheitliche Sprache. Entwickler und Designer nutzen diese
Sprache, um ein konsistentes, skalierbares und wiederverwendbares Design in der
Expand Down
0 ...dations/design/design-tokens/overview.mdx → ...s/01-design/01-design-tokens/overview.mdx
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions ...2-foundations/design/typography/index.mdx → ...dations/01-design/05-typography/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Typography
---

# Fonts

Für Benutzeroberflächen wird hauptsächlich die Font **Inter** verwendet. Sie
Expand Down
0 ...ucture/layout/examples/general-layout.tsx → ...ure/01-layout/examples/general-layout.tsx
View file
Open in desktop
File renamed without changes.
0 ...ucture/layout/examples/mStudio-layout.tsx → ...ure/01-layout/examples/mStudio-layout.tsx
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions ...02-foundations/structure/layout/index.mdx → ...ndations/02-structure/01-layout/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Layout
---

Das Layout organisiert die Benutzeroberfläche in einer logischen und
hierarchischen Struktur, um die Aufmerksamkeit des Users gezielt zu lenken.
Dabei werden Elemente wie Header, Navigation und Content-Bereich berücksichtigt.
0 ...foundations/structure/layout/overview.mdx → ...tions/02-structure/01-layout/overview.mdx
View file
Open in desktop
File renamed without changes.
0 ...ructure/spacing/examples/falseSpacing.tsx → ...ture/02-spacing/examples/falseSpacing.tsx
View file
Open in desktop
File renamed without changes.
0 ...ructure/spacing/examples/rightSpacing.tsx → ...ture/02-spacing/examples/rightSpacing.tsx
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions ...2-foundations/structure/spacing/index.mdx → ...dations/02-structure/02-spacing/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
---
title: Spacing
---

Spacing definiert die vertikalen und horizontalen Abstände zwischen Elementen
und sorgt so für ein harmonisches Layout.
0 ...oundations/structure/spacing/overview.mdx → ...ions/02-structure/02-spacing/overview.mdx
View file
Open in desktop
File renamed without changes.
0 ...content-guidelines/sprach-guide/index.mdx → ...tent-guidelines/01-sprach-guide/index.mdx
View file
Open in desktop
File renamed without changes.
43 changes: 22 additions & 21 deletions ...tent-guidelines/fehlermeldungen/index.mdx → ...t-guidelines/02-fehlermeldungen/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Fehlermeldungen
---

# Best Practices

- Platziere Fehlermeldungen in unmittelbarer Nähe zur Ursache des Problems.
Expand Down Expand Up @@ -27,8 +31,9 @@ [email protected] ein."

## Verständliche Sprache auf Augenhöhe

Wähle eine Sprache, die dem Kontext der jeweiligen Benutzeroberfläche entspricht.
Fehlermeldungen müssen klar und verständlich formuliert sein. In bestimmten Fällen kann dabei eine etwas technischere Sprache hilfreich sein.
Wähle eine Sprache, die dem Kontext der jeweiligen Benutzeroberfläche
entspricht. Fehlermeldungen müssen klar und verständlich formuliert sein. In
bestimmten Fällen kann dabei eine etwas technischere Sprache hilfreich sein.

<DoAndDont>
<Do exampleText="Wir konnten keine Verbindung zum Server herstellen. Bitte versuche es erneut." />
Expand Down Expand Up @@ -60,7 +65,7 @@ schiefgegangen?" und "Wer muss handeln, um es zu beheben?" einfach und
verständlich beantwortet.

<DoAndDont>
<Do
<Do
exampleText="Wir konnten dein Passwort nicht zurücksetzen. Bitte überprüfe die E-Mail-Adresse
und versuche es erneut."
/>
Expand Down Expand Up @@ -97,12 +102,12 @@ ist. Gibt es mehrere mögliche Gründe, so sollte die Fehlermeldung beschreiben,
wie der wahrscheinlichste Grund zu beheben ist.

<DoAndDont>
<Do exampleText="Bitte wähle ein Passwort mit mindestens 8 Zeichen.">
</Do>
<Dont exampleText="Das eingegebene Passwort entspricht nicht den Mindestanforderungen. Stelle
<Do exampleText="Bitte wähle ein Passwort mit mindestens 8 Zeichen." />
<Dont
exampleText="Das eingegebene Passwort entspricht nicht den Mindestanforderungen. Stelle
sicher, dass es min. 8 Zeichen, einen Groß- und Kleinbuchstaben, eine Ziffer und
ein Sonderzeichen enthält.">
</Dont>
ein Sonderzeichen enthält."
/>
</DoAndDont>

## Nicht zu spezifisch
Expand All @@ -113,22 +118,20 @@ Ordner zu nennen, da der Nutzer diese Informationen an anderen Stellen in der
Benutzeroberfläche finden kann.

<DoAndDont>
<Do exampleText="Wir konnten die Datei nicht hochladen. Bitte verwende eine Datei vom Typ XY.">
</Do>
<Dont exampleText="Wir konnten die Datei „example_file-20.4.24.xy“ nicht hochladen. Bitte verwende
eine Datei vom Typ XY.">
</Dont>
<Do exampleText="Wir konnten die Datei nicht hochladen. Bitte verwende eine Datei vom Typ XY." />
<Dont
exampleText="Wir konnten die Datei „example_file-20.4.24.xy“ nicht hochladen. Bitte verwende
eine Datei vom Typ XY."
/>
</DoAndDont>

## Aktiv schreiben

Fehlermeldungen werden aktiv formuliert, um das Verständnis zu erleichtern.

<DoAndDont>
<Do exampleText="Wir unterstützen nur Dateien vom Typ XY.">
</Do>
<Dont exampleText="Es werden nur Dateien vom Typ XY unterstützt.">
</Dont>
<Do exampleText="Wir unterstützen nur Dateien vom Typ XY." />
<Dont exampleText="Es werden nur Dateien vom Typ XY unterstützt." />
</DoAndDont>

## Positiv formulieren
Expand All @@ -140,8 +143,6 @@ getan werden kann. Beachte jedoch, dass dies in Fällen von Systemfehlern, für
die es keine direkte Lösung gibt, nicht immer möglich ist.

<DoAndDont>
<Do exampleText="Wir konnten keine Verbindung zum Server herstellen. Bitte versuche es erneut.">
</Do>
<Dont exampleText="Durch ein Problem mit dem Server ist die Verbindung fehlgeschlagen.">
</Dont>
<Do exampleText="Wir konnten keine Verbindung zum Server herstellen. Bitte versuche es erneut." />
<Dont exampleText="Durch ein Problem mit dem Server ist die Verbindung fehlgeschlagen." />
</DoAndDont>