Hilfe:Inhaltsverzeichnis: Unterschied zwischen den Versionen
Aus Faces Dokumentation
Sophie (Diskussion | Beiträge) |
Mirjam (Diskussion | Beiträge) |
||
| Zeile 1: | Zeile 1: | ||
| − | Diese Dokumentation soll bei Fragen und Unklarheiten rund um die Umbrella | + | Diese Dokumentation soll bei Fragen und Unklarheiten rund um die Umbrella Faces Suite weiterhelfen. |
| − | * Die Dokumentation der Umbrella | + | * Die Dokumentation der Umbrella Faces 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 | + | * In der Online-Dokumentation werden sämtliche Bildschirme der Umbrella Faces Suite beschrieben, sowie die möglichen Arbeitsabläufe aufgezeigt. |
Beispiele: | Beispiele: | ||
| Zeile 13: | Zeile 13: | ||
| − | * Die Online-Dokumentation kann direkt aus der Umbrella | + | * Die Online-Dokumentation kann direkt aus der Umbrella Faces Suite über den 'Dokumentations - Link' unten rechts 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. | * 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. | * 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. | ||
| Zeile 23: | Zeile 23: | ||
* Inhaltsverzeichnis: Am Anfang jeder Seite steht ein Inhaltsverzeichnis. | * Inhaltsverzeichnis: Am Anfang jeder Seite steht ein Inhaltsverzeichnis. | ||
* Übersicht: Es folgt eine Kurzbeschreibung über den aufgerufenen Bildschirm. | * Übersicht: Es folgt eine Kurzbeschreibung über den aufgerufenen Bildschirm. | ||
| − | * Layout: Hier wird ein Printscreen von Umbrella | + | * Layout: Hier wird ein Printscreen von Umbrella Faces Suite aufgezeigt. |
* Benutzeroberfläche: Im Menüpunkt 'Benutzeroberfläche' erfolgt eine Beschreibung sämtlicher Felder. | * 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. | * Arbeitsabläufe / Prozesse: Hier wird beschrieben, welche Arbeitsabläufe vom angezeigten Bildschirm aus möglich sind. | ||
* Technische Details: Hier werden technische Informationen aufgeführt. | * Technische Details: Hier werden technische Informationen aufgeführt. | ||
Aktuelle Version vom 6. Juni 2016, 12:29 Uhr
Diese Dokumentation soll bei Fragen und Unklarheiten rund um die Umbrella Faces Suite weiterhelfen.
- Die Dokumentation der Umbrella Faces 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 Faces 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:
Diese Funktion gilt für die folgenden BerechtigungsstufenWenn 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 der Umbrella Faces Suite über den 'Dokumentations - Link' unten rechts 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 Faces Suite 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.
