Zum Hauptinhalt springen

Design

In diesem Bereich finden Sie Hinweise zur visuellen und strukturellen Gestaltung von Dokumentationsseiten.

  • Design-Tipps

    • Hinweise zur sprachliche Gestaltung
    • Empfehlungen zur Verbesserung der Lesbarkeit
    • Formale Konventionen

  • Admonitions verwenden

    • Grundprinzipien
    • Welche Box wofür?
    • Syntax (Markdown)

  • Aufklappbare Bereiche (Details)

    • Wann <details> reicht
    • Wann @theme/Details sinnvoll ist
    • Beispiele (Quelltext und Ausgabe)

  • FAQ-Seiten erstellen

    • Struktur
    • Priorisierung der wichtigsten Fragen
    • Darstellung (Akkordeon und Navigation)
    • Wording (Fragen so formulieren, wie Nutzer denken)
    • Inhaltliche Tipps