Zum Hauptinhalt springen

Tutorial Template

Dies ist ein Template für den Aufbau der Tutorial

Ziel qmBase ist es für jede App eine Tutorial Seite zu haben. Diese soll alle Funktionen dokumentieren.

Der Aufbau muss überall gleich sein, damit der Leser sich schnell zu recht findet.

Folgendes Schema ist zu verwenden:

  • Funktion 1
    • Beschreibung welche Parameter sich verändern lassen
    • Auswirkungen und Effekte E-Mail Benachrichtigungen usw.
    • Praxisbeispiel
  • Funktion 2
    • ...

Beispiel

Erstellen von Maßnahmen

Mit dieser Funktion erstellen Sie Maßnahmen. Beim Erstellen können Sie folgende Werte festlegen:

ParameterTypBeschreibung
TitelTextKurzer Titel mit dem sich die Maßnahmen wiederfinden lässt
BeschreibungText (optional)
FristDatumBis wann soll die Maßnahme erledigt sein

Auswirkungen und Aktionen im Hintergrund

Beim Erstellen einer Maßnahme wird der Verantwortliche per E-Mail benachrichtig. Wenn Sie selbst der Verantwortliche sind, bekommen Sie keine E-Mail.

Beispiel aus der Praxis

Kickoff Meeting für Projekt Abfallvermeidung durchführen

Bearbeiten von Maßnahmen

wie oben