3.6.4 Dokumentation von Abfragen: Glossare

Die Statistiken in SuperX ist nicht immer für Außenstehende "selbsterklärend", und insbesondere bei Kennzahlen und kondensierten Werten sollten die Konzepte mit einem Glossar versehen sein.

Die Oberfläche des Systems bietet drei Möglichkeiten der Dokumentation:

• • Dialogelemente auf den Masken können mit einem "Tool-Tip" versehen werden, d.h. bei Mausbewegung über den Button wird eine Erläuterung angezeigt. 

• • Ergebnistabellen können mit einem Glossar versehen werden, das die in der Tabelle benutzten Begriffe auf einer zweiten Seite erläutert. 

• • Umfangreichere Hilfetexte sind über die kontextabhängigen Hilfetexte zu einem Themenbereich, z.B. "Studierende" verlinkt.  

Für alle Dokumentationsarten wird dies im Menü Administration -> Masken -> Beschriftungen suchen ( Tabelle sx_captions )   gepflegt, die Felderläuterungen und allgemeine Schlüssel w örter dokumentieren. Die Dokumentation ist sogar mehrsprachig möglich. Es werden immer Standardtexte ausgeliefert, die die Hochschule aber beliebig ändern kann.

Generell gilt: wenn eine Hochschule Beschriftungen ändert, werden diese nicht durch das System (z.B. beim Upgrade)   überschrieben. Nur bei Deinstallation eines Moduls werden die zugehörigen Beschriftungen gelöscht.

---