Dokumentation

Mit der Online Dokumentation können im Backend Kapitel über mehrere Hierarchiestufen erstellt werden. Die Kapitel sind je nach Sichtbarkeit öffentlich, also ohne Login auf der Webseite sichtbar, oder an bestimmte Benutzerberechtigungen gebunden. Über die Kategorien kann für einen externen Benutzer eine personalisierte Dokumentation zur Verfügung gestellt werden.


Kapitel

Über Website - Dokumentation gelangt man zu den Kapitel. Jedes Kapitel kann als Teil eines anderen Kapitels definiert werden, womit eine Hierarchie erstellt werden kann. Für die Darstellung auf der Webseite sind sechs unterschiedliche Titelgrössen definiert, daher sollte die Hierarchie nicht mehr als 6 Stufen haben.

  • Name

  • Aktiv; zum steuern ob der Beitrag auf der Webseite sichtbar ist

  • Teil von; Auswahl für übergeordnetes Kapitel

  • Nummernfolge; wird automatisch nachgeführt

  • Link; wird zum Verlinken von einem anderen Kapitel verwendet (Querverweise)

  • Untergeordnete sind Hauptkapitel; Hauptkapitel werden beim Klick gefiltert (siehe Hauptkapitel)

  • Webseiten

  • Sichtbar für; Einschränkung nach Benutzerberechtigungen, leer = öffentlich

  • Kategorien; zur Einschränkung auf bestimmte Themen und Verknüpfung mit Adressen

  • Verknüpfen mit; Verknüpfung auf anderes Kapitel (siehe Verknüpfung von Kapiteln)

  • Text; Editorfeld

  • Erstellt von / am

  • Aktualisiert von / am; Letzte Änderungen am Datensatz, auch z.B. durch Umsortierung

  • Geändert von / am; Letzte Änderung nur an Text oder Titel


Bilder

Bilder können mit CTRL+V oder über den "File/Image"-Button eingefügt werden. Damit sich die Bildgrösse der Fenstergrösse des Webbrowsers anpasst muss das Bild und dann der Button "Shape: Thumbnail" angewählt werden.


Verknüpfung von Kapiteln

Wenn ein Teil einer Dokumentation mehrfach vorkommt, so muss dieser Text nicht mehrfach geführt werden. Das Kapitel wird einmal erstellt und kann danach an verschiedenen Orten in der Dokumentation wiederverwendet werden.

Dazu wird am neuen Ort ein Kapitel angelegt und mit "Verknüpfen mit" auf das bestehende Kapitel verwiesen. Dabei wir das Textfeld gesperrt und der Text des Vorlage-Kapitels übernommen. Die Daten unter "Information" sind beim Erstellen auf dem Tagesdatum. Sobald das Vorlage-Kapitel geändert wird, werden die Felder "Aktualisiert" und "Geändert" nachgeführt.


Darstellung

In der Listenansicht können die Kapitel mit dem Kreuzpfeil-Symbol an die gewünschte Position gezogen werden. Da jedesmal die Nummernfolge neu aufgebaut wird, muss nach jedem verschobenen Kapitel die Seite durch den Benutzer über die Taste F5 neu geladen werden. Die Einträge können auch nach "Erstellt am" oder "Geändert am" sortiert werden. Zur einfacheren Übersicht können die Kapitel nach Ebenen gefiltert werden. Untergeordnete Kapitel werden immer automatisch mit dem Kapitel verschoben.

Auf einem übergeordneten Kapitel können oben über die weiterführenden Funktionen die Untergeordneten Kapitel angezeigt werden.


Hauptkapitel

Mit dem Feld "Untergeordnete sind Hauptkapitel" wird das Verhalten beim Klick auf ein Kapitel im Baum festgelegt. Ein Klick auf ein Hauptkapitel verhält sich wie ein Filter, es wird nur noch das gewählte Kapitel und seine Unterkapitel angezeigt. Dies ist die Standardeinstellung.

Ist ein Kapitel nicht als Hauptkapitel festgelegt, verhält sich der Klick auf das Kapitel so, dass der Fokus auf das Kapitel springt und es zuoberst angezeigt wird, ohne dass dabei die anderen Kapitel ausgeblendet werden.


HR ist Hauptkapitel, so wird der Rest der Dokumentation ausgeblendet, Personal ist kein Hauptkapitel, beim Klick springt der Fokus auf das Kapitel.


Kategorien

Kategorien dienen zur Einschränkung der Dokumentation auf bestimmte Themen. Jedes Kapitel kann mehreren Kategorien angehören. Die Kategorien gelten auch für untergeordnete Kapitel. Die Kategorien können hierarchisch angelegt werden.

  • Name

  • Aktiv

  • Oberkategorie; Auswahl für übergeordnete Kategorie

  • Nummernfolge; wird automatisch vergeben


Kundenspezifische Dokumentation

Kategorien können auch auf Adressen hinterlegt werden. Somit ergibt sich eine Verknüpfung von Kapiteln und Kunden was eine kundenspezifische Dokumentation ermöglicht. Der Kunde braucht ein Portal-Login (externer Benutzer). Wenn sich der Kunde auf seinem Portal anmeldet, wird die Dokumentation eingeschränkt dargestellt, z.B. nur die Themenbereiche die ihn betreffen.


Suche

Die Suche in der Dokumentation auf der Webseite beitet verschiedene Möglichkeiten:

  • Suche nach Text in den Kapiteln

  • Erweiterte Suche nach neuen Kapiteln über "Erstellt seit"

  • Erweiterte Suche nach neuen und geänderten Kapiteln über "Geändert seit"

  • Einschränkung nach Kategorien