Hilfe:Navigation: Unterschied zwischen den Versionen

Aus Umbrella.net Documentation
Wechseln zu: Navigation, Suche
(Generelle Informationen)
 
(35 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
== Generelle Informationen ==
+
Die Umbrella.net Online Dokumentation soll bei Fragen und Unklarheiten rund um Umbrella.net weiterhelfen.
  
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.  
  
Sie ist wiefolgt aufgebaut:
+
Beispiele:  
  
== Seitenleiste ==
+
Wenn sich die Dokumentations-Seite ausschliesslich auf ein Modul bezieht, so ist das wie folgt markiert: 
 +
<module name="Beispiel">Diese Seite bezieht sich ausschliesslich auf das Modul Beispiel.</module>
  
Am linken Rand unter dem Logo wird eine Seitenleiste angezeigt. Diese Naviationsleiste enthält Links zu den übergeordneten Seiten der Dokumentation.
+
Wenn Menüpunkte / Buttons etc. nur für bestimmte Berechtigungsstufen ersichtlich sind, sind diese wie folgt markiert:
 +
<auth type="Superuser,Buchhalter,Supervisor">Diese Funktion gilt für die folgenden Berechtigungsstufen</auth> 
  
* Durch klicken auf das Logo oder auf 'Hauptseite' kommt man jederzeit zurück auf die Startseite der Dokumentation.
+
Wenn Menüpunkte / Buttons etc. ab einem bestimmten Release aktiv werden, so sind diese folgendermassen markiert:
 +
<release since="10.01">Beispiel für Release-Kennzeichnung: Diese Funktion ist ab Release 10.01 verfügbar</release>
  
* Umbrella.net Bildschirme
 
  
* Umbrella.net Module
+
* 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.
 +
* Benutzer von Kuoni und TUI müssen sich in Umbrella.net einloggen, um die Spezialfunktionen von Kuoni / TUI anschauen zu können.
  
* Systemweite Funktionen
 
  
* Navigation
 
  
* Werkzeuge
+
== 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.

Aktuelle Version vom 7. Oktober 2013, 15:09 Uhr

Die Umbrella.net Online Dokumentation soll bei Fragen und Unklarheiten rund um Umbrella.net 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.

Beispiele:

Wenn sich die Dokumentations-Seite ausschliesslich auf ein Modul bezieht, so ist das wie folgt markiert:

Module: BeispielDiese Seite bezieht sich ausschliesslich auf das Modul Beispiel.


Wenn Menüpunkte / Buttons etc. nur für bestimmte Berechtigungsstufen ersichtlich sind, sind diese wie folgt markiert:

Diese Funktion gilt für die folgenden Berechtigungsstufen

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.
  • Benutzer von Kuoni und TUI müssen sich in Umbrella.net einloggen, um die Spezialfunktionen von Kuoni / TUI anschauen zu können.


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.