Dokumentation zur Onlineanleitung
Unsere OdAOrg-Mandanten haben jeweils eine Onlineanleitung für ihre Lernenden, Dozenten, Administratoren etc. Die Anleitungen bestehen aus Elementen, welche für alle Mandanten identisch sind und solchen, welche spezifisch für den Kunden angepasst werden mussten.
Die einzelnen Anleitungen bestehen jeweils aus einer Einstiegsseite, die den Pfad und eventuell kleine Hinweise zur Anleitung enthält. Anschliessend wird der User über einen Link zur Seite mit der Beschreibung geführt. Hierbei handelt es sich um einen Screenshot der anvisierten Seite auf der die einzelnen Felder, Aktionen, etc. beschrieben sind.
Screenshots
Die Screenshots zu den einzelnen Seiten sind unter G:\60 - Softwareentwicklung\OdAOrg\Manual_Screenshot abgelegt. Die Bezeichnung besteht aus der Modulbezeichnung und der dazugehörenden Ziffer (Bsp. IVAdresse_10100.png).
Beschreibung zu den Screenshots
Für jeden Screenshot wird auf dem Wiki-Tool eine eigene Seite erstellt. Auf dieser Seite werden die auf dem Screenshot abgebildeten Felder, Funktion etc. beschrieben. Für jedes Modul besteht ein Link der die jeweiligen Screenshots beinhaltet.
Odaorg
IVVerwaltung
IVAdresse
IVEval
Hinweis:
Die einzelnen Modulnummern sind jeweils in Blöcke gegliedert. Der erste Link besteht aus einer dreistelligen Ziffer und der Bezeichnung "gesamt" (Bsp. 120:Feiertag gesamt). In diesem Link können mehrere Scrennshots zusammengefasst werden. Sie erscheinen dann untereinander. Hierfür muss auf der Wiki-Seite der Befehl "Include" und anschliessend die Bezeichnung eingetragen werden.
Beispiel:
[[Include(IVVerwaltung_12000_de)]]
[[Include(IVVerwaltung_12010_de)]]
Anleitung erstellen
Bei den Anleitungen sind drei Typen zu unterscheiden.
- Anleitung ist für alle Mandanten identisch
- Eine Anleitung die für alle Mandanten gilt, muss teilweise für einen einzelnen Mandanten angepasst werden
- Eine Anleitung besteht nur für einen einzelnen Mandanten
1. Anleitung für alle Mandanten
Auf dem Wiki-Tool wird der Link zur Anleitung wie folgt hinterlegt: [wiki:Prozess_12345_de]. Die fünfstellige Zahl folgt keinem Schema. Sie kann nach Belieben gewählt werden.
Bei der Erfassung einer neuen Anleitung ist darauf zu achten, dass vor dem eigentlichen Textinhalt fünf Abstände [[BR]] eingetragen werden. Dies ist für die spätere Anzeige auf OdAOrg relevant. Ohne die Abstände, würde die Anleitung auf OdAOrg zu weit oben angezeigt werden.
Anschliessend kann der Textteil zur Anleitung erfasst werden. Hierbei ist darauf zu achten, dass jeweils der Pfad angegeben wird. Am Ende wird ein Link zur Beschreibung des Screenshots angefügt.
2. Abweichende Anleitung
Auf dem Wiki-Tool wird der Link grundsätzlich analog zu Punkt 1. hinterlegt. Zusätzlich wird aber das Kürzel des Mandanten vorne angestellt; Bsp. [wiki:Odaag_Prozess_12345_de]
3. Anleitung für einzelne Mandanten
Auf dem Wiki-Tool wird der Link grundsätzlich analog zu Punkt 2. hinterlegt. Zusätzlich wird aber eine weitere Ziffer hinzugefügt; Bsp. [wiki:Odaag_Prozess_123456_de]
Rechte
Rechte erstellen
Damit unsere Kunden die Onlineanleitungen individuell für ihre User aufschalten können, müssen vorgängig die Rechte erstellt und anschliessend zugeteilt werden. Zu beachten gilt, dass neue Rechte stehts auf dem trunk des jeweiligen Mandanten erfasst werden. Auf dem trunk für alle Mandanten (trunk.odaorg.local) werden demnach keine Rechte erfasst. Wird dies nicht berücksichtigt, werden die Rechte beim nächsten Update überschrieben. Ebenfalls dürfen keine neuen Rechte auf dem Live erstellt werden.
Die Rechte werden unter [Stammdaten > Rechte > IVHilfe > Rechte] erfasst. Im Feld "Rechtecode" wird die fünf- respektive sechsstellige Zahl der Anleitung eingetragen. Im Feld "Rechtename" kann eine beliebe Bezeichnung gewählt werden.
Bemerkung:
Die vorne angestellten Kürzel müssen nicht angegeben werden. Das System erkennt automatisch, wenn eine abweichende Anleitung erstellt wurde und zeigt nur diese an.
Rechte zuteilen
Die Anleitungen werden jeweils für die Rollen festgelegt [Stammdaten > Rechte > IVHilfe > Rechte aller Rollen]. Damit der Hilfe-Link für den User unter "Persönliche Links" überhaupt ersichtlich ist, muss das Recht 1000 Hilfe anzeigen gesetzt sein.
