__Helpdesk-Artikel-Vorlage

ℹ️
[Kurze Beschreibung, worum es sich in diesem Artikel handelt.]
In der Schüler-Ansicht öffnen sich alle Schüler:innen im System. Sie dient der Verwaltung der Stammdaten der Schüler:innen und ist in mehrere Sektionen aufgeteilt.

Relevant für

  • ÖPNV
  • FSV
  • Erstattung

Weitere Artikel


Sektions-Überschrift (H2)

Die Sektions-Überschriften separieren den Helpdesk-Artikel. Eine Sektion ist immer ein View, also ein Fenster, oder ein Container, der eine dedizierte Funktion bereitstellt.

In einem VIA-Fenster können mehrere Sektionen existieren. Es sollte maximal 3-4 H2-Überschriften geben. Wenn es mehr als 4 Sektionen in einem View gibt, sollten lieber Unter-Seiten verwendet werden, damit der Artikel nicht zu lang wird.

Eine Sektion schließt am besten mit einer Linie (drei Striche machen).

Feature-Überschrift (H3)

Bilder sollten entweder im Fließtext eingebunden werden, oder rechts neben den Textblock.

Features innerhalb einer Sektion gibt es verschiedene Features. Diese sollten mit H3-Überschriften abgetrennt werden. Features sind Inhalte innerhalb der Sektion, die erwähnenswert sind.

Es können beliebig viele Features einer Sektion hier beschrieben werden.

Bildbeschreibungen sind auch nützlich, wenn man noch auf was hinweisen will

Weitere Strukturelle Inhalte

⚠️
Wenn etwas gibt, dass wir hervorheben wollen, sollten wir einen “Callout” verwenden. Z. B. wenn eine Funktion veraltet ist oder nur in bestimmten Konfigurationen verfügbar ist.
  1. Das Vorgehen zu einer Funktion
  1. sollten wir in nummerierten
  1. Listen schreiben
TabellensindCheck?
auch immerziemlich
übersichtlichoder?

⚡ Emojis helfen dabei Text bildlich zu unterstützen. Sie sollten darum vor allem in Überschriften oder Callouts, jeweils am Beginn, verwendet werden. 🙈 Fließtext-Emojis hingegen sehen wieder unprofessionell aus und sollten eher nicht verwendet werden.

Wo immer es geht, sollten wir andere Seiten verlinken. Das geht inline 13.1 VIA Schnittstellen und auch als direkter Link unter einem Absatz:

Umso wichtiger ist es, dass wir die Seiten-Titel sehr aussagekräftig machen.


Hier geht es weiter

[Vielleicht gibt es noch verwandte Artikel, die wir hier verlinken können?]