Hilfe:Navigation: Unterschied zwischen den Versionen
Aus Umbrella.net Documentation
K |
K (→Menüleiste) |
||
| Zeile 12: | Zeile 12: | ||
== Menüleiste == | == Menüleiste == | ||
| − | Auf der linken Seite der Online-Dokumentation befindet sich | + | Auf der linken Seite der Online-Dokumentation befindet sich eine Menüleiste. |
| Zeile 41: | Zeile 41: | ||
|- | |- | ||
|} | |} | ||
| − | |||
| − | |||
== Aufbau einer Dokumentations-Seite für Bildschirme == | == Aufbau einer Dokumentations-Seite für Bildschirme == | ||
Version vom 24. Mai 2013, 12:47 Uhr
Die Umbrella.net Online Dokumentation soll bei Fragen und Unklarheiten weiterhelfen.
- Die Dokumentation von Umbrella.net 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 Umbrella.net Bildschirme beschrieben, sowie die möglichen Arbeitsabläufe aufgezeigt.
- Dokumentiert werden sämtliche Module, die Umbrella.net bietet. Falls gewisse Funktionen nur mit einzelnen Modulen möglich sind, werden diese Module innerhalb der Dokumentation entsprechend gekennzeichnet. Ebenso werden Berechtigungsstufen gekennzeichnet, wenn diese für einzelne Funktionen notwendig sind.
- Die Online-Dokumentation kann direkt aus Umbrella.net über das '?' in der rechten oberen Ecke des Bildschirms gestartet werden.
- Ein Klick auf das Logo in der linken oberen Ecke des Bildschirms verzweigt auf die Hauptseite der Online-Dokumentation.
Menüleiste
Auf der linken Seite der Online-Dokumentation befindet sich eine Menüleiste.
Menüleiste Umbrella.net
| Titel | Beschreibung |
|---|---|
| Hauptseite | Ein Klick auf den Menüpunkt 'Hauptseite' verzweigt auf die Hauptseite der Online-Dokumentation. |
| Einzelne Bildschirme | Unter dieser Rubrik sind alle Hauptmenüpunkte von Umbrella.net aufgeführt. Mittels Klick auf einen Menüpunkt erscheint eine detaillierte Bildschirmbeschreibung sowie eine Beschreibung der von diesem Bildschirm aus möglichen Arbeitsabläufe. |
| Module | Unter dieser Rubrik werden sämtliche Zusatzmodule von Umbrella.net beschrieben. Eine kurze Beschreibung erklärt die Hauptfunktionen des jeweiligen Moduls. Mittels Klick wird auf die detaillierten Funktionen des Moduls verzweigt. |
| Systemweite Funktionen | Hier werden Funktionen beschrieben, welche nicht einzelne Bildschirme von Umbrella.net betreffen, sondern Umbrella.net im Allgemeinen. |
| Troubleshooting | In dieser Rubrik werden die häufigsten Meldungen (gelbe Balken) von Umbrella.net beschrieben. |
| Glossar | Im Glossar werden Begriffe erklärt. |
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.
