Für diese Arbeit wird Help+Manual eingesetzt, weil es Single-Source-Publishing unterstützt: Inhalte werden in einer gemeinsamen Quelle gepflegt und daraus in verschiedenen Ausgabeformaten veröffentlicht. Die topicbasierte Struktur und die Wiederverwendung von Textbausteinen (Snippets) ermöglichen es zudem, dieselben Inhalte in mehreren Dokumentationen zu verwenden. Verlinkte (verknüpfte) Inhalte werden an ihrer Quelle gepflegt und an mehreren Stellen verwendet.
Als lokal nutzbares Autorensystem benötigt Help+Manual für die redaktionelle Arbeit keine Internetverbindung und auch keine Serverumgebung. Gegenüber umfangreichen, rein webbasierten Systemen bleibt damit der technische Betriebsaufwand für die hier verwendete Dokumentationsumgebung überschaubar.
Der dateibasierte Projektaufbau ermöglicht ausserdem die Bearbeitung der Quellen mit externen Werkzeugen. Diese Möglichkeit wird für die später beschriebenen Praxisfälle genutzt.
Help+Manual eignet sich für unterschiedliche Dokumentationsprodukte, darunter Wissensbasen, technische Dokumentationen, Handbücher, Online-Hilfen und Anleitungen. Die verschiedenen Ausgabeformate ermöglichen sowohl die Nutzung im Webbrowser als auch die Bereitstellung als druckbares Dokument oder E-Book.
Formatvorlagen und Ausgabevorlagen vereinheitlichen die Gestaltung der Dokumentation von den Projektarbeiten.
Die tägliche Bearbeitung der Inhalte erfolgt in der grafischen Oberfläche des Autorentools, für besondere Aufgaben stehen die zugänglichen XML-Quellen zur Verfügung.
Die laufende Inhaltsbearbeitung erfolgt in Help+Manual. Für dateiübergreifende Änderungen werden die XML-Quelldateien zusätzlich mit einem externen Editor bearbeitet. Die entsprechenden Arbeitsschritte werden in den Praxisfällen dokumentiert.
Für die Dokumentation der Projektarbeiten wird Help+Manual X10 in der Professional Edition unter Windows 11 eingesetzt. Die beschriebenen Funktionen, Einstellungen und Praxisbeispiele beziehen sich auf diese Version und Edition. |
Weitere Informationen sowie die zugehörige Website finden sich bei [Web:H+M].
Abbildung 8: Benutzerschnittstelle von Help+Manual.
Quelle: Eigener Screenshot.
