Verwaltung > Erstellen interner Dokumentationen > Konzepte > Interne Dokumentation – Übersicht

Interne Dokumentation – Übersicht

Die Funktion für die interne Dokumentation ermöglicht es Ihnen, die vorhandene Online-Hilfe mit Ihrer eigenen benutzerdefinierten Dokumentation (als Text oder URL) zu ergänzen.

Die Benutzer greifen auf diese Dokumentation zu, indem sie auf die Schaltfläche Hilfe im relevanten Bereich des Produkts klicken. In der Produkthilfe wird unter der Überschrift Interne Dokumentation ein Link zu einer Seite mit Ihrer Dokumentation angezeigt.

Sie erstellen interne Dokumentationen im Administratormodul über den Ausschnitt Interne Dokumentation. Weitere Details finden Sie unter Ausschnitt "Interne Dokumentation".

Beispiel:

John ist Release Control-Administrator im Unternehmen ABC. Sue, die Webadministratorin, teilt John mit, dass sie jeden Montag die Websitewartung durchführen wird, und bittet John, in Release Control eine Zeitperiodenkategorie zu erstellen, mit der verhindert wird, dass Benutzer montags Änderungen an der Unternehmenswebsite durchführen.

John erstellt eine Zeitperiodenkategorie mit dem Namen Web_blackout. Wenn Release Control-Benutzer im Analysemodul zum Register Bewerten > Zeitperiodenkonflikte wechseln, wird ihnen möglicherweise angezeigt, dass sich ihre geplante Änderung mit der Zeitperiode Web_blackout überschneidet. John möchte eine interne Dokumentation verfassen, um den Benutzern den Grund für diese Zeitperiodenkategorie zu erläutern.

Er wechselt zum Ausschnitt Interne Dokumentation (Modul > Administrator > Register Konfiguration > Interne Dokumentation), wechselt dann zu Zeitperiodenkonflikte im Ausschnitt Produktbereich und übermittelt die Dokumentation, indem er die erforderlichen Felder ausfüllt und seine Änderungen speichert:

Wenn Benutzer im Analysemodul zu Bewerten > Register Zeitperiodenkonflikte wechseln und auf die Schaltfläche Hilfe klicken, wird ein Link zu Johns Dokumentation angezeigt, die die neue Zeitperiode in der Produkthilfe erläutert.

Wenn Benutzer auf den Link klicken, wird eine separate Seite mit dem von John übermittelten Inhalt geöffnet. John hätte die Zeitperiode auch auf der internen Unternehmenswebsite dokumentieren und einen URL einfügen können, anstatt den Text über den Ausschnitt Interne Dokumentation zu übermitteln. In diesem Fall würde über den Link der URL direkt geöffnet.