Erstellen Sie eine Benutzerhandbuchhilfe

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 2 Minuten Lesedauer
  • Hilfedokumente für Benutzerhandbücher sind in entsprechenden Abschnitten auf der Seite gruppiert und in einer konfigurierbaren Reihenfolge aufgelistet. Fügen Sie Ihre Abschnitte einer Hilfeseite hinzu.

    Vorbereitungen

    Erstellen Sie alle Ihre Hilfedokumente innerhalb des Abschnittsdatensatzes. Auf diese Weise können Sie ihre Titel verfeinern, ihre Platzierung anpassen und entscheiden, ob sie für den Abschnitt geeignet sind.

    Erforderliche Rolle: admin

    Prozedur

    1. Erstellen Sie eine Seite.
      1. Navigieren zu System-Benutzerhandbuch > Administration > Hilfeseiten und klicken Sie auf Neu.
      2. Füllen Sie das Formular aus.
        Tabelle : 1. Felddefinitionen der Hilfeseite
        Feld Beschreibung
        ID Seitenidentifizierung, die vom System zum Erstellen einer Hilfe-URL verwendet wird.
        Anwendung Anwendungsbereich für diese Hilfeseite. Dieses Feld ist schreibgeschützt und standardmäßig auf den Bereich Global festgelegt.
        Titel Anzeigetitel für diese Seite.
      3. Klicken Sie auf Absenden.
        Hilfeseite des Benutzerhandbuchs
    2. Erstellen Sie Hilfeseitenabschnitte, und ordnen Sie sie der Seite zu.
      1. Navigieren zu System-Benutzerhandbuch > Administration > Abschnitte einer Hilfeseite und klicken Sie auf Neu.
        Abschnittsdefinition des Benutzerhandbuchs
      2. Geben Sie Ihrem Abschnitt einen eindeutigen und aussagekräftigen Titel, und klicken Sie dann auf Absenden.
        Die Ansicht kehrt zur Liste der Abschnitte zurück.
      3. Erstellen Sie zusätzliche Abschnitte für Ihre Hilfeseite.
      4. Navigieren zu System-Benutzerhandbuch > Administration > Hilfeseiten und öffnen Sie die neue Seite.
      5. Klicken Sie in der zugehörigen Liste „ Seite zu Abschnitten “ auf Neu.
      6. Füllen Sie das Formular aus.
        Tabelle : 2. Seite zu Abschnitt – Felddefinitionen
        Feld Beschreibung
        Spalte Spaltenposition auf der Seite für diesen Abschnitt. Die erste Spalte wird als 0 und die zweite Spalte als 1bezeichnet. Für die anzuzeigenden Abschnitte muss mindestens ein Eintrag für Spalte 0 vorhanden sein.
        Bestellen Reihenfolge, in der die Abschnitte in den Spalten auf der Seite angezeigt werden. Wenn keine Reihenfolgennummer definiert ist, listet das System die Abschnitte in alphabetischer Reihenfolge auf.
        Anwendung Anwendungsbereich für diesen Datensatz Dieses Feld ist schreibgeschützt und standardmäßig auf den Bereich Global festgelegt.
        Seite Hilfeseite, auf der dieser Abschnitt angezeigt wird. Sie können das Suchfeld verwenden, um die Seite zu ändern, auf der ein Abschnitt angezeigt wird.
        Abschnitt Name des Abschnitts, der auf der ausgewählten Seite angezeigt werden soll.
        Abschnitte auf einer Hilfeseite platzieren
      7. Klicken Sie auf Absenden.
      8. Wahlweise: Fügen Sie der Hilfeseite nach Bedarf Abschnitte hinzu.
    3. Erstellen Sie ein oder mehrere Dokumente.
      1. Navigieren zu System-Benutzerhandbuch > Administration > Abschnitte einer Hilfeseite.
      2. Öffnen Sie einen von Ihnen erstellten Abschnittsdatensatz.
      3. Klicken Sie in der zugehörigen Liste Hilfe auf Neu, um ein Hilfedokument für diesen Abschnitt zu erstellen.
      4. Füllen Sie das Formular aus.
        Tabelle : 3. Hilfedokument-Felddefinitionen
        Feld Beschreibung
        Nummer Dokumentnummer, die automatisch vom System generiert wird.
        Abschnitt Abschnitt, in dem dieses Dokument angezeigt wird.
        Bestellen Listenreihenfolge für dieses Dokument im ausgewählten Abschnitt.
        Veröffentlicht Datum, an dem dieses Dokument erstellt wurde.
        Aktualisiert Datum, an dem dieses Dokument zuletzt aktualisiert wurde.
        Kurzbeschreibung Kurze Beschreibung des Inhalts dieses Dokuments. Diese Beschreibung wird als Titel für das Dokument auf der Hilfeseite verwendet.
        Text Dokumentinhalt, einschließlich Grafiken und Tabellen. Sie können Ihren Eintrag formatieren, Aufzählungslisten oder nummerierte Listen erstellen und Bilder anhängen.
        Hilfedokument zum Benutzerhandbuch
      5. Klicken Sie auf Absenden.
      6. Wiederholen Sie den Vorgang, um die erforderlichen Hilfedokumente für diesen Abschnitt zu erstellen.
        Abschnittsdatensatz mit Hilfedokumenten