Hilfe:Inhaltsverzeichnis
Aus Faces Dokumentation
Version vom 11. Oktober 2013, 13:38 Uhr von Sniederb (Diskussion | Beiträge) (Die Seite wurde neu angelegt: «Diese Dokumentation soll bei Fragen und Unklarheiten rund um die Umbrella Tenzing Suite weiterhelfen. * Die Dokumentation der Umbrella Tenzing Suite ist nach de…»)
Diese Dokumentation soll bei Fragen und Unklarheiten rund um die Umbrella Tenzing Suite weiterhelfen.
- Die Dokumentation der Umbrella Tenzing Suite ist nach dem "Wiki-Prinzip" aufgebaut. D.h. die Anpassungen der Dokumentation z.B. auf neue Releases, erfolgt laufend. Es kann ebenso vorkommen, dass einzelne Seiten der Dokumentation noch nicht ganz vollständig dokumentiert sind.
- In der Online-Dokumentation werden sämtliche Bildschirme der Umbrella Tenzing Suite beschrieben, sowie die möglichen Arbeitsabläufe aufgezeigt.
Beispiele:
Wenn Menüpunkte / Buttons etc. nur für bestimmte Berechtigungsstufen ersichtlich sind, sind diese wie folgt markiert:
Wenn Menüpunkte / Buttons etc. ab einem bestimmten Release aktiv werden, so sind diese folgendermassen markiert:
Ab Release 10.01Beispiel für Release-Kennzeichnung: Diese Funktion ist ab Release 10.01 verfügbar
- Die Online-Dokumentation kann direkt aus Umbrella.net über das '?' in der rechten oberen Ecke des Bildschirms gestartet werden.
- Ein Klick auf das Logo innerhalb der Online-Dokumentation in der linken oberen Ecke des Bildschirms verzweigt auf die Hauptseite der Online-Dokumentation.
- Jede Seite er Online-Dokumentation hat eine "Druckversion". Diese kann über den Menüpunkt "Druckversion" im Bereich "Werkzeuge" auf der linken Seite des Bildschirms aufgerufen resp. ausgedruckt werden.
Aufbau einer Dokumentations-Seite für Bildschirme
Je nach des zu beschreibenden Bildschirms, ist die Länge der Dokumentations-Seite unterschiedlich. Der Aufbau ist jedoch immer derselbe:
- Inhaltsverzeichnis: Am Anfang jeder Seite steht ein Inhaltsverzeichnis.
- Übersicht: Es folgt eine Kurzbeschreibung über den aufgerufenen Bildschirm.
- Layout: Hier wird ein Printscreen von Umbrella.net aufgezeigt.
- Benutzeroberfläche: Im Menüpunkt 'Benutzeroberfläche' erfolgt eine Beschreibung sämtlicher Felder.
- Arbeitsabläufe / Prozesse: Hier wird beschrieben, welche Arbeitsabläufe vom angezeigten Bildschirm aus möglich sind.
- Technische Details: Hier werden technische Informationen aufgeführt.
