Hallo zusammen!
Heute arbeite ich immer noch an den Boxen des Startbildschirms und habe mich insbesondere mit der Erstellung einer „perfekten“ Box beschäftigt.
Das Ziel ist es, Richtlinien in der Dokumentation zu schreiben 
Ich habe die Box „Benutzerpräsenz“ genommen, die anzeigt, wer zu Hause ist und wer abwesend ist.
Die Box sieht so aus:
Hier ist der Inhalt, den ich in die Richtlinien aufnehmen werde.
Fehlerbehandlung
Die Box muss Fehler behandeln und eine entsprechende Fehlermeldung anzeigen:
- In natürlicher Sprache (kein JavaScript-Dump)
- In der Sprache des Benutzers (über die native Internationalisierung von Gladys 4)
- Die Fehlermeldung muss detailliert sein, für jeden möglichen Fehlertyp (Netzwerkfehler, Gerät nicht verfügbar, usw.)
- Der Fehler muss dem Benutzer anzeigen, wie er das Problem beheben kann: Die Anleitung muss klar sein und den Benutzer nicht zu den Protokollen oder technischen Manipulationen führen. Wenn der Fehler nur vorübergehend ist und keine Maßnahmen erforderlich sind, geben Sie dies an.
- Der Fehler muss im Rahmen der Box angezeigt werden und nicht außerhalb, damit der Benutzer den Kontext des Fehlers versteht.
Beispiel:
Ladezeiten verwalten
Der Benutzer muss wissen, wenn etwas im Hintergrund passiert. Wenn Sie eine Anfrage starten, müssen Sie dies in der Benutzeroberfläche mit dem Standard-Loader von Gladys 4 anzeigen.
- Der Loader muss in der Box sein
- Achten Sie darauf, dass die Box eine Mindestgröße hat, damit der Loader nicht oben in der Box komprimiert wird.
- Denken Sie daran, den Loader zu entfernen, wenn die Anfrage fehlschlägt. Der Loader ersetzt nicht die Fehlermeldung.
Beispiel:
Live-Verwaltung
Eine Box sollte nicht nur Daten anzeigen, sondern sicherstellen, dass sie während ihres gesamten Lebenszyklus aktuell bleibt.
Das Gladys-Dashboard hat das Ziel, einen langen Lebenszyklus zu haben, daher werden einige Boxen mehrere Tage/Wochen/Monate angezeigt, wenn der Benutzer das Tab in Vollbild auf einem Wandtablet lässt.
Jede Box muss Web-Sockets verwenden oder sich zumindest periodisch aktualisieren, um aktuell zu bleiben.
Beispiel für eine Live-Aktualisierung:
Größe der Box
Ihre Box zeigt eine Reihe von Daten an, die wahrscheinlich dynamisch sind. Achten Sie auf die Mindest- und Maximallängen der Daten.
Wenn Sie eine Liste anzeigen, achten Sie darauf, der Box eine maximale Größe zu geben und dem Browser eine Scroll-Leiste hinzuzufügen, wenn die Liste zu lang ist. Dadurch wird verhindert, dass Ihre Box riesig wird, wenn der Benutzer eine große Installation hat.
Wenn Ihre Box systematisch zu lang ist, denken Sie darüber nach, das Konzept Ihrer Box zu ändern, und ermöglichen Sie dem Benutzer beispielsweise, in der Box-Konfiguration einen Unterbereich der Daten auszuwählen.
Beispiel für eine Scroll-Leiste:
Leere Zustände
Wenn Ihre Box leer sein kann, denken Sie daran, einen speziellen Zustand zu erstellen, der angibt, wie die Box gefüllt werden kann.
Beispiel:
Das sind die Richtlinien, die ich in der Entwicklerdokumentation veröffentlichen möchte
Letztlich gelten diese Richtlinien für das gesamte Gladys, aber die Boxen sind ein gutes Beispiel.
Zögern Sie nicht, wenn Sie Mängel an diesen Richtlinien finden!