Einführung in die Webhilfe

Die Dokumentation der Serviceware-Anwendungen steht ab sofort als Webhilfe zur Verfügung.

Sie finden so künftig immer die aktuellsten Informationen zu Ihrem Release. Die Suche nach Informationen wird vereinfacht, da Sie nicht mehr in einzelnen Büchern suchen müssen, sondern alles an einem Ort finden. Die Suchfunktion verkürzt den Weg zur Information.

Die Serviceware-Dokumentation bietet Informationen für Benutzer und für Administratoren an.
  • Als Benutzer erhalten Sie Informationen zur Nutzung der Serviceware-Plattform für Ihre Arbeit. Sie erfahren, wie Sie Ihren Arbeitsplatz einrichten und wie Sie Prozesse intuitiv mitgestalten können.
  • Als Administrator erhalten Sie Informationen zur Installation und zur Konfiguration Ihrer Anwendung. Sie erfahren, wie Sie Prozesse gestalten und wie Sie Dialoge an die Anforderungen Ihres Unternehmens anpassen können.
Anmerkung: Je nachdem, welche Startkonfiguration und welche Version der Software Sie verwenden, können sich die Dialog-Abbildungen von denen in Ihrem System unterscheiden. Dennoch ist die Funktionalität der beschriebenen Menüs, Schaltflächen und Routinen bei allen Versionen weitgehend die gleiche.

Aufbau der Webhilfe

Die Webhilfe lässt sich aufteilen in eine Startseite und eine Inhaltsseite, bestehend aus der Dokumentation der Serviceware-Produkte. Beide Seiten haben Funktionen, die hier kurz erklärt werden:
Logo
Das Serviceware-Logo führt von jedem Ort in der Webhilfe zur Startseite zurück.
Navigationsmenü
Das Navigationsmenü befindet sich neben dem Serviceware-Logo und erlaubt zwischen den einzelnen Modulen zu wechseln.
Suchfunktion
Über die Suchleiste können Begriffe in der Webhilfe gesucht werden. Kacheln: Die Kacheln öffnen die einzelnen Module
Die Inhaltsseite ist folgendermaßen aufgebaut:
Hauptfenster
Im Hauptfenster werden die Inhalte dargestellt. Diese bestehen aus dem Titel, einer Kurzbeschreibung und, je nach Länge des Kapitels, auch aus Unterkapiteln.
Menüs
Am linken Rand befindet sich die Menüleiste, die eine schnelle Navigation zwischen den Kapiteln erlaubt. Sind in einem Kapitel Unterkapitel enthalten, erscheint am rechten Rand eine zweite Menüleiste, die eine Navigation zwischen den Abschnitten ermöglicht.
Brotkrümelnavigation

Ebenfalls in der Inhaltseite lässt sich die Brotkrümelnavigation finden, der den Herkunftsort des Textes anzeigt. Rechts neben der Brotkrümelnavigation am oberen, rechten Rand der Inhaltsseite, befinden sich ein Druckersymbol, sowie ein Symbol, das zurück nach ober an den Anfang der Seite führt.

Weitere Informationen sind im Video zu finden.

Plattform- und Modulbereich

Die Webhilfe verfügt über einen Modul- und einen Plattformbereich.
  • Der Plattform-Bereich enhält die Dokumentation der gesamten Serviceware-Plattform. Die Suche im Plattform-Bereich erfolgt über die gesamte Webhilfe in einer Sprache. Die Ergebnisse werden beziehen sich jeweils auf die aktuellste Version jedes Plattform-Moduls.
    Anmerkung: Es ist möglich, dass im Plattformbereich neue Features und Arbeitsweisen beschrieben sind, die in Ihrer - möglicherweise nicht aktuellen - Software-Version nicht enthalten sind.
  • Der Modul-Bereich enthält die Dokumentation eines Moduls der Serviceware Platform in einer Version und Sprache - beispielsweise Serviceware Financial Financial 6.7 in deutscher Sprache. Im Modul-Bereich schließt die Suche nur die ausgewählte Version und Sprache des Moduls ein. Zu jeder Modul-Seite gibt es eine Startseite, auf der die unterschiedlichen Sprachen und Versionen ausgewählt werden können. Es ist möglich über die Startseiten der Module zwischen Plattform- und Modulbereich zu wechseln.

Weiter Informationen sind in dem Video zu finden.

Arbeiten mit der Webhilfe


Screenshot: Link zur Webhilfe

Die Webhilfe öffnen Sie aus Ihrer Anwendung.

Beachten Sie die folgenden Hinweise.

Einige Textabschnitte sind besonders wichtig oder enthalten nützliche Hinweise. Lesen Sie die gekennzeichneten Abschnitte besonders sorgfältig.
WARNUNG: Als Warnung sind Hinweise gekennzeichnet, die Sie auf jeden Fall beachten müssen, damit Ihr System weiterhin wie erwartet funktioniert.
Anmerkung: Dieses Symbol kennzeichnet besonders wichtige Textstellen, die Sie auf keinen Fall überlesen sollten.
Tipp: Dieses Symbol bezeichnet Tipps und Tricks, die Ihnen die Arbeit mit Ihrer Serviceware-Anwendung erleichtern.

Regeln für Suchbedingungen in der Webhilfe

Die Webhilfe bietet die typischen Merkmale einer Suchfunktion.


Screenshot: Suchfeld

Für Suchbedingungen gilt:
  • Eingrenzung: Suchbedingungen sind AND/OR-verknüpft. (Technische OR-Daten)
  • Exakte Suche: Anführungszeichen um eine Wortabfolge ("Technische Daten").
  • Auslassung: Minuszeichen einsetzen; Service -ware zeigt Ergebnisse mit Service aber ohne Ware an. "*" funktioniert nicht.
  • Sonderzeichen: Die Suche nach Sonderzeichen innerhalb einer Wortfolge ist eingeschränkt möglich.
  • Groß-/Kleinschreibung wird nicht beachtet.
  • Wildcards: Die Webhilfe hängt automatisch an jeden Suchbegriff den Platzhalter "*" (Asterisk) an, sodass auch Wörter gefunden werden, die mit dem Suchbegriff beginnen: „Drucker“ findet zum Beispiel auch „Druckertinte“ oder „Druckertreiber“. Weitere Platzhalter werden nicht unterstützt.

Informationen zu Sprache und Lokalisierung

Die Online-Dokumentation wird in zwei Sprachen erstellt – Deutsch und Englisch.

Zur Umschaltung der Sprache stehen Links im Hauptmenü sowie in jeder Produkt- bzw. Moduldokumentation zur Verfügung.

Eine Umschaltung der Sprache ist in einigen Fällen auch durch eine Anpassung des Sprachkürzels in der URL möglich (.../de/... <-> .../en/...).

Die englische Dokumentation erfährt eine vollständige Lokalisierung und wird auf die englischsprachigen Softwareoberflächen angepasst. Sollten Sie die Softwareoberfläche in einer anderen Sprache nutzen, bedenken Sie, dass Unterschiede bei Schreibweisen – z. B. Einheiten, Datums- und Zeitangaben – vorliegen können. So können die Angaben in der Dokumentation von den Einstellungen, die Sie in Ihrer Anwendung machen, abweichen. Achten Sie immer auf die korrekte Umsetzung für Ihren Sprachraum.
Tipp: Zeit- und Datumsangaben werden immer entsprechend der Browser-Sprache lokalisiert.

Genderneutrale Sprache

Als Zeichen von Respekt und Wertschätzung bemühen wir uns um sprachliche Gleichberechtigung.

Das generische Maskulinum wird künftig weitgehend vermeiden. Um die Texte barrierearm und maschinenlesbar zu halten, wird – wenn keine genderneutrale Formulierung möglich ist - der Genderdoppelpunkt verwendet.

Wir behalten uns im Sinne der Übersichtlichkeit vor, zunächst bei der Beschreibung von Rollen weiterhin die männliche Variante zu verwenden – beispielsweise Agent, Anwender, Benutzer, Administrator. So soll die Konsistenz von bereits bestehender und neuer Dokumentation sowie zwischen Softwareoberflächen und Dokumentation gewahrt werden.