Allgemeines
Auf diesen Dokumentationsseiten können Benutzer und die IT die jeweils benötigten Informationen zur Applikation "DDS" finden.
Sie sind links aufgegliedert in verschiedene Kapitel.
Es gibt eine integrierte Suche durch diese Dokumentation an der oberen rechten Seite.
Grundsätzlicher Aufbau der Applikation (Details)
Das Anzeigefenster der App ist prinzipiell in 4 Bereiche eingeteilt:
- Hauptmenü oben
- Hauptfenster
- Fußzeile
- Externe Fenster/Tabs (Daten-Preview und diese Hilfeseite)
Hauptmenü
Das Hauptmenü finden Sie in der blauen Leiste oberhalb des Hauptfensters. Die einzelnen Komponenten der DDS können von dort aus erreicht werden. Zudem finden Sie dort auch Ihr Profil mit Abmelde-Button und das Hilfesymbol. Falls das Fenster zu klein wird (Bsp. halber Bildschirm), wird das Menü in ein Hamburger-Menü komprimiert.
Fußzeile
Hier werden Lognachrichten angezeigt und gespeichert, seitenübergreifend während Sie die Applikation navigieren. Beispielnachrichten sind das erfolgreiche Speichern von Objekten oder eine Nachricht, wie viele Datenpunkte mit gegebenen Parametern gefunden wurden.
Die Lognachrichten werden nach Typ farblich kodiert (grün = Erfolg, rot = Fehler, schwarz = neutral/Information)
Standardmäßig wird nur die zuletzt aufgetretene Nachricht angezeigt. Sie können auf die Fußzeile klicken, um ein ausführlicheres Log anzeigen zu lassen.
Es werden die letzten 10 Nachrichten in der Historie angezeigt, die seit dem letzten Aktualisieren (F5) des Browsers geschrieben wurden.
Diese Hilfe
Erreichbarkeit dieser Hilfe
Die Dokumentation ist als Online-Hilfe ausgelegt, die man mit dem Hilfebutton (Fragezeichen) aus der Applikation heraus jeweils zielgerichtet erreichen kann. In der Regel findet man diesen an der oberen rechten Ecke des Fensters oder Dialogs.
Sie wird dabei in einem eigenen Tab / Fenster geöffnet, kann also mit den Browser-Möglichkeiten auf einem zweiten (bzw. dritten) Bildschirm gelegt werden. Wenn Sie erneut auf den Hilfe-Button klicken, passt sich das Fenster automatisch an.
Struktur dieser Hilfe
Sie können natürlich auch direkt in der Hilfe selbst, über das Inhaltsverzeichnis links, zu den einzelnen Unterseiten navigieren. Zusätzlich sind häufig Schlüsselwörter mit Links versehen, die Sie zur relevanten Unterseite weiterleiten.
Beispiel: Datenpunkte
Die Hilfe hat ihre eigene Historie, mit dem Zurück-Button im Browser kommen Sie auf die vorherige Seite zurück.
Es werden auch direkte Links aus anderen Dokumentationen oder Linksammlungen unterstützt.
Benutzerführung der Applikation
Die Applikation ist möglichst intuitiv gestaltet:
- Die Buttons sind farbkodiert - blau ist reserviert für Aktionen wie Bestätigen, Fortfahren oder Speichern. Rot steht für Löschen oder andere destruktive Optionen. Grau sind sekundäre Optionen wie Schließen oder Abbrechen.
- In den meisten Eingabefeldern, insbesondere in der Suche, funktioniert die Enter-Taste als Aktivator für den dazu passenden blauen Button.
- Das Eintragen von Werten in Input-Felder löst noch keine Abfrage aus, erst der Klick auf den Button sendet Daten an den Server.
TIP
Prinzipiell sind die Deeplinks aller Unterseiten über URL-Parameter eindeutig definiert und von der User-Session unabhängig, können also an andere Benutzer weitergegeben werden (etwa um die Detailansicht eines Datenpunkts zu teilen). Wenn sich allerdings die interne ID der Objekte ändert (etwa bei einem Löschen und Neuanlegen), verfallen diese Links.