Skip to content

Commit

Permalink
docs: Adjust the order of Menu Items on Foundations (#946)
Browse files Browse the repository at this point in the history
  • Loading branch information
BenniEngel authored Nov 6, 2024
1 parent fa9e494 commit 6bb2956
Show file tree
Hide file tree
Showing 14 changed files with 38 additions and 21 deletions.
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
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
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.
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.
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>

0 comments on commit 6bb2956

Please sign in to comment.