Dank HelpNDoc’s leistungsstarker, bedingungsabhängiger Generierungsfunktion und dem großartigen Build-System können vielfältige Versionen von Master-Dokumentationen nun einfacher und schneller denn je produziert werden. Stellen Sie sich vor eine vollständige Hilfedatei, Dokumentation, ein Handbuch oder Buch zu schreiben und danach auszuwählen, welche Sektionen ins Endprodukt mit eingeschlossen werden sollen. Können Sie sich bereits eine Idee darüber machen, wie leistungsstark diese Funktion wirklich ist? Dank dieser Funktion können vielfältige Variationen Ihrer Master-Dokumentationen den verschiedenen Kunden, Mandanten, Partner, usw. zur Verfügung gestellt werden! Lesen Sie weiter, um zu erfahren wie Sie das bedingungsabhängige Generierungssystem von HelpNDoc effizient anwenden.

Erstellen Sie eine Basis-Dokumentation und fügen Sie Bedingungen hinzu

Nehmen wir zum Beispiel an, dass wir eine Dokumentation für ein Softwareprodukt erstellen und wir zwei Dokumentationsdateien zur Verfügung stellen möchten: Eine ist an den Endbenutzer gerichtet und die andere richtet sich ans Support-Team und beinhaltet zusätzliche Informationen (in der gesamten Dokumentation verstreut).

Wir beginnen mit dem Erstellen eines neuen Projekts und fügen unsere anfänglichen Themen und Inhalte hinzu. Nun können wir einen Bedingungen-Abschnitt definieren, welcher nur fürs Support-Team ersichtlich sein wird. Wir nennen diesen “technischer” Abschnitt.

Insert a conditional operation

  • Setzen Sie den Cursor vor den technischen Teil der Dokumentation im Themeneditor
  • Klicken Sie auf “Bedingung einfügen/bearbeiten” in der Registerkarte “Einfügen”
  • Stellen Sie sicher, dass die “Falls”-Operation selektiert wurde und klicken Sie auf den “Tags verwalten”-Link, um die Tags für dieses Projekt zu bearbeiten
  • Fügen Sie im neu geöffneten “Build-Tags verwalten”-Fenster ein Tag mit dem Namen “Technisch” zur Liste hinzu und klicken Sie OK
  • Überprüfen Sie den neu hinzugefügten “Technisch”-Tag im Fenster “Bedingte Operationen einfügen” und klicken Sie OK

Um den technischen Abschnitt zu schließen, können Sie eine “ENDE”-Operation hinzufügen, mit welcher jede zuvor geöffnete “Falls”, “Falls nicht” oder “Sonstige” Operation geschlossen wird und alle Inhalte, welche auf die “ENDE”-Operation folgen, werden in jedem Build mit einbezogen werden. Setzen Sie den Cursor nach dem technischen Abschnitt, klicken Sie auf “Bedingung einfügen/bearbeiten” in der Registerkarte “Einfügen”, wählen Sie die “ENDE”-Operation und klicken Sie OK.

Example of a conditional section

Einrichtung der Builds, um vielfältige Variationen zu generieren

Wir werden zwei PDF-Builds erstellen: Das erste wird an den Endbenutzer vertrieben und wird keine technischen Informationen enthalten. Das zweite wird nur ans Support-Team verteilt und beinhaltet alle technischen Abschnitte.

Sobald der Inhalt bereit steht, sollen vielfältige Variationen der Enddokumentation generiert werden. Dazu müssen zwei verschiedene PDF-Builds erstellt werden.

Customize builds to include conditional sections

  • Klicken Sie auf den oberen Teil von “Hilfe generieren” in der Registerkarte “Start”
  • Löschen Sie alle bestehenden Builds in der Build-Liste mit Ausnahme der “Build-PDF-Dokumentation”. Markieren Sie dazu jedes Build einzeln und klicken Sie auf die “Löschen”-Taste
  • Fügen Sie ein weiteres PDF-Build zur Liste hinzu, indem Sie auf die “Hinzufügen”-Taste klicken
  • Markieren Sie das erste Build und ändern Sie den Namen dieses Builds auf “PDF für Endbenutzer”. Nennen Sie das zweite Build “PDF fürs Support-Team”
  • Markieren Sie das “PDF fürs Support-Team”-Build und klicken Sie auf den “Anpassen”-Link in der Sektion “Build Einstellungen”, falls die Anpassungen nicht bereits eingeblendet sind
  • Gehen Sie zum Tab “Enthaltene Tags” und markieren Sie das Kontrollkästchen “Technisch” für dieses Build: Hiermit werden die technischen Abschnitte in diesem Build miteinbezogen
  • Klicken Sie auf “Generieren” und überprüfen Sie beide erstellten PDF-Dokumentationsdateien

Generated PDF builds differences

HelpNDoc ist dank diesem einmaligen, bedingungsabhängigen Generierungssystem das perfekte Tool, um verschiedene Variationen von Dokumentationen, Handbücher, Büchern oder Hilfedateien zu generieren, welche den verschiedene Zielgruppen entsprechend angepasst werden können. In diesem schnellen Überblick haben Sie sicherlich erkannt, wie extrem einfach und doch unglaublich leistungsstark dieses HelpNDoc-Tool ist, um verschiedene Dokumentations-Versionen von einer einzigen Quelle aus erstellen zu können. Überzeugen Sie sich selbst und downloaden Sie jetzt die Gratisversion von HelpNDoc.

Das könnte Sie auch interessieren


Kategorien: artikel