So können Sie eine automatisierte Dokumentationserstellung planen

Technische Redakteure müssen häufig Dokumentationen, Handbücher oder Hilfe-Websites erstellen und diese dann mit Teammitgliedern teilen oder ihren Endnutzern bereitstellen. Dies kann ein zeitaufwändiger Prozess sein, der Sorgfalt und Aufmerksamkeit erfordert, um sicherzustellen, dass die korrekte Version regelmäßig erstellt wird. Glücklicherweise kann das Hilfe-Entwicklungstool HelpNDoc zur Durchführung einer geplanten Dokumentationserstellung automatisiert werden. Im Folgenden erfahren Sie, wie Ihnen das gelingt.

Anwendung von HelpNDocs Kommandozeilenschnittstelle

Sie können HelpNDocs Vorgang zur Dokumentationserstellung durch eine Eingabeaufforderung oder PowerShell-Eingabeaufforderung zur Erstellung aller durch das Hilfe-Entwicklungstool unterstützten Formate automatisieren.

HelpNDoc bietet eine [äußerst leistungsfähige Kommandozeilenschnittstelle] (/documentation/html/Usagefromthecommandline.html), die zur Erstellung jedes unterstützten Dokumentationsformats ohne weitere Benutzerinteraktionen genutzt werden kann. Beispielsweise generiert die folgende Kommandozeile alle Builds, die in einem Projekt mit dem Namen MyProject.hnd eingerichtet und aktiviert wurden:

hnd6.exe MyProject.hnd build

Die Kommandozeile build bietet mehrere Optionen zur Festlegung des zu generierenden Dokumentationsformats, zur Auswahl der anzuwendenden Tags sowie zum Überschreiben von Variablen. Beispielsweise wird die folgende Kommandozeile nur solche Themen des HTML-Dokumentationsformats erstellen, die als Abgeschlossen (für die öffentliche Nutzung bereit) markiert wurden:

hnd6.exe MyProject.hnd build -only="Build HTML documentation" -statuses="Build HTML documentation:Complete"

Sie können sich HelpNDocs Kommandozeilendokumentation ansehen, um mehr über die möglichen Optionen zu erfahren und die für Ihre spezifischen Anforderungen passende Kommandozeile einzurichten. Sobald Sie dies getan haben, können wir im nächsten Schritt eine Dokumentationserstellung als Aufgabe planen.

Automatisieren der Dokumentationserstellung

Nachdem die gewünschte Kommandozeile definiert wurde, können wir eine geplante Aufgabe zur periodischen Ausführung einrichten und sicherstellen, dass die generierte Dokumentation stets auf dem neuesten Stand ist.

Es gibt mehrere Werkzeuge für eine “kontinuierliche Integration” oder Build-Systeme zur Ausführung geplanter oder getriggerter Kommandozeilen. Wir verwenden beispielsweise Windows integrierte “Aufgabenplanung”, um täglich eine neue Version einer HTML-Dokumentation zu erstellen. So geht‘s:

Klicken Sie auf das Windows-Logo in der Taskleiste.
Beginnen Sie mit der Eingabe von “Aufgabenplanung” und klicken Sie das Programm an, um es zu starten.
Klicken Sie im Menü “Aktion” auf “Aufgabe erstellen”.
Geben Sie einen “Namen” und optional eine “Beschreibung” an und klicken Sie dann auf “Weiter”.
Wählen Sie den gewünschte “Trigger” (z. B. “täglich”) aus und klicken Sie dann auf “Weiter”.
Passen Sie die Trigger-Optionen wie z. B. die Startzeit an und klicken Sie dann auf “Weiter”.
Wählen Sie die Aktion “Ein Programm starten” aus und klicken Sie dann auf “Weiter”.
Geben Sie HelpNDocs vollständigen Pfad in dem Feld “Programm/Script” an. In der Regel lautet der Pfad:
"C:\Programmdateien (x86)\IBE Software\HelpNDoc 6\ hnd6.exe"
Geben Sie den Rest der zuvor definierten Kommandozeile in das Feld “Argumente hinzufügen” ein, zum Beispiel:
MyProject.hnd -verysilent build -only="Build HTML documentation" -statuses="Build HTML documentation:Complete".
Hinweis: Das Kommandozeilenargument -verysilent wurde hinzugefügt, um zu vermeiden, dass bei der Ausführung von HelpNDoc eine Eingabeaufforderung angezeigt wird.
Geben Sie den vollständige Pfad Ihrer HND-Projektdatei in das Feld “Starten in” ein, zum Beispiel: C:\Dokumentation\. Klicken Sie auf “Weiter”.
Überprüfen Sie alles, klicken Sie auf “Fertig stellen”, und schon haben Sie’s geschafft! Die Dokumentationserstellung wurde jetzt als Aufgabe geplant.

Durch die Nutzung von HelpNDocs integrierter Kommandozeilenschnittstelle sowie Windows Aufgabenplanung (oder eines anderen automatisierten Build-Systems) können Sie Ihre Dokumentationserstellung schnell und einfach automatisieren. HelpNDoc kann technischen Redakteuren so viel Zeit und Mühe bei der Bereitstellung aktueller Dokumentationen für Endbenutzer oder Teammitglieder sparen.