Inhaltsverzeichnis
Wir bei doctima sind große Fans von Content-Management-Systemen mit vielen integrierten Funktionalitäten, die eine dynamische Ausgabe von flexiblen, aber dennoch standardisierten Formaten ermöglichen. Zugegeben, für die umfängliche Nutzung solcher Systeme ist eine gewisse Einarbeitung notwendig, aber der Aufwand lohnt sich – vor allem, wenn danach eine hohe Zahl von Dokumenten für viele Produkte und Produktvarianten zentral und effizient verwaltet werden kann.
Aber auch für etwas niedrigere Anforderungen und kleinere Projekte gibt es Autorenwerkzeuge. Die sind nicht ganz so anspruchsvoll, können aber trotzdem oft erstaunlich vielseitige Dienste leisten. Eines dieser Werkzeuge wollen wir heute vorstellen: Das Programm Help+Manual, das – wie der Name schon sagt – vor allem bei der Erstellung von Hilfedokumenten und Anleitungen seine Unterstützung anbietet.
Recycling-Weltmeister
Mit Help+Manual lassen sich Projekte erstellen und verwalten, aus denen Dokumente in unterschiedlichem Format generiert werden können. Ein Projekt besteht dabei aus
-
Wiederverwendung einer Topic-Datei im Inhaltsverzeichnis
den Projektdateien, diese setzen sich zusammen aus
- „Topic-Dateien“, sie bilden das Reservoir an Kapitelbausteinen und enthalten Texte, Tabellen, eingebundene Grafiken usw.
- „Baggage Dateien“, das sind Grafiken und andere eingebundene Elemente, die in dem Projekt verwendet werden.
- dem bzw. den Inhaltsverzeichnis(sen), in dem/denen die Topic-Dateien mit Drag and Drop angeordnet werden und dadurch die konkrete Struktur und Gliederung des zu erstellenden Dokuments bilden.
- Konfigurationseinstellungen für jedes Projekt.
Durch die Erstellung mehrerer Inhaltsverzeichnisse in einem Projekt werden Teilprojekte definiert, die alle Zugriff auf dieselben Topic-Dateien haben. In den Teilprojekten können dann beispielsweise Hilfen oder Anleitungen für Produktvarianten bearbeitet werden.
In den Inhaltsverzeichnissen werden die Topic-Dateien wiederverwendet, so dass die Kapitel (Topics) nur an einer Stelle gepflegt werden müssen, aber in vielen Teilprojekten eingesetzt werden können (siehe Abbildung). Und das funktioniert auch in kleinerem Maßstab: „Schnipsel“ enthalten einzelne Wörter bis hin zu ganzen Absätzen und können ebenfalls in verschiedenen Kapiteln immer wieder verwendet werden. Dies sorgt für inhaltliche Konsistenz über die Kapitel und Ausgabeformate hinweg und erleichtert auch die Arbeit: Anpassungen müssen nur an einer Stelle vorgenommen werden, stehen dann aber automatisch überall, wo der Inhalt verwendet wird.
WYSIWYG oder XML? Beides!
Auf den ersten Blick erinnert Help+Manual an ein Microsoft-Office-Produkt, denn mit dem Menüband wurde ein bekanntes Konzept übernommen. Das erleichtert den optischen Einstieg; hinsichtlich der Funktionalität grenzt sich Help+Manual aber schnell von Word und Co. ab.
Die Bearbeitung erfolgt in einem Editor. Der zeigt zwar nicht ganz hundertprozentig „WYSIWYG“, aber das ist bei Projekten, die prinzipiell auf Medienneutralität und flexibles Ausgabepotenzial angelegt sind, ganz normal. Zumal die Darstellung doch Layout erahnen lässt: Tabellen erstellen, Bilder oder Videos einfügen, Seiten verlinken oder Text formatieren – all diese typischen Arbeitsschritte sind mit wenigen Mausklicks erledigt und im Editor sichtbar. Jedes Topic lässt sich jedoch blitzschnell auch im eingebauten XML-Editor anzeigen, der einen anderen Blick auf die zugrundeliegende Struktur ermöglicht.
PDF oder HTML? Beides, und mehr!
Einer der Vorteile, den gute Autorenwerkzeuge im Vergleich zu den Standard-Office-Produkten bieten, ist eine leicht anwendbare Umsetzung des Single-Source-Prinzips (das auch von der kürzlich aktualisierten Norm IEC/IEEE 82079-1 für Gebrauchsinformationen gefordert wird): Inhalte werden medienneutral an einer Stelle verwaltet, können aber in verschiedenen Formaten für unterschiedliche Medien ausgegeben werden. Help+Manual bietet etwa folgende Output-Möglichkeiten an: PDF- oder Word-Datei, Windows-Hilfe (CHM) oder HTML-Format, als ePub oder für Kindle u.a.m. Sogenannte „Skins“ sorgen für das jeweils passende Layout; sie können auch noch ans Corporate Design angepasst werden.
Auch die bedingte Ausgabe von Inhalten ist möglich: Sowohl Kapitel bzw. Unterkapitel als auch einzelne Stellen darin können für die selektive Ausgabe gekennzeichnet werden: Für die Ausgabe in einem bestimmten Ausgabeformat, aber auch für die Ausgabe in einer definierten Produktvariante o. Ä. Variablen sorgen für zusätzliche Flexibilität.
Viele Köche verderben hier nichts
Ein gemeinsamer Zugriff auf ein Projekt kann mit Help+Manual beispielsweise erfolgen, indem das Projekt auf einem Netzlaufwerk abgelegt wird. Wenn nun ein Redakteur in einem Kapitel arbeitet, ist dieses Kapitel für andere Bearbeiter gesperrt, so dass Änderungen nicht unbeabsichtigt überschrieben werden können. Auch mit dem Microsoft Team Foundation Server kann das Programm eingesetzt werden.
Verschiedene (konfigurierbare) Topic-Status helfen beim Bearbeitungsworkflow. Ebenfalls gedacht ist an Anforderungen zur Übersetzung: In der Professional-Version zeigt ein Tool alle Änderungen an, die im Ausgangstext vorgenommen wurden, seitdem das Projekt zuletzt übersetzt worden ist.
Eine Kurzübersicht gibt außerdem für jedes Projekt einen Überblick darüber, welche Topics zuletzt bearbeitet wurden und wie sich die Bearbeitungszeit auf die vergangenen Monate verteilt.
Fast-Alles-Könner
Man ist geneigt zu fragen, was das Programm denn nicht kann. Eine Antwort wäre: Pizza backen. Eine etwas ernsthaftere Antwort: Bei sehr umfangreichen Projekten mit vielen Varianten oder Teilprojekten bzw. Übersetzungen (die ebenfalls Teilprojekte sind) könnte die Übersichtlichkeit bei den Inhaltsverzeichnissen und Topic-Dateien doch leiden.
So weit muss man aber erst einmal kommen. Alles in allem ist Help+Manual, gerade für kleinere und mittlere Projekte, ein Autorenwerkzeug, das eine hohe Flexibilität ermöglicht und mit Wiederverwendungen und verschiedenen Ausgabeformaten sehr effiziente Arbeit erlaubt.
Nutzen Sie Help+Manual bereits für Ihre Hilfen und Anleitungen, oder haben Sie für diesen Zweck eine andere Software im Einsatz? Schreiben Sie uns doch gerne Ihre Vorlieben und Eindrücke in die Kommentare. Wir sind gespannt auf Ihre Erfahrungen!
