Generator für digitale Dokumentationen

Gleichgültig, wie gross sich Softwarehersteller das Wort «Benutzerfreundlichkeit» auf ihre Fahnen geschrieben haben: Ohne integrierte Hilfefunktion kommt keine Anwendung aus. Doch nicht nur bei Computerprogrammen, auch in anderen Gebieten sind elektronische Dokumentationen verbreiteter denn je. Anwendungen wie Flare von Madcap Software haben sich auf die Erstellung solcher Unterlagen spezialisiert. Den Schwerpunkt setzt das Programm beim Aufbau von Hilfen für Windows-Anwendungen. Dazu bietet Flare eine Fülle an Funktionen, um bestehende oder neu erstellte Unterlagen zu einer bequem bedienbaren, digitalen Dokumentation inklusive Inhaltsverzeichnis, Index und Suchfunktion zusammenzustellen.

Im ersten Jahr ihres Bestehens hat die Software einiges durchgemacht. Die Versionsnummer ist bis auf 2.5 geklettert. Und der Hilfegenerator wurde um kommerzielle Zusatzanwendungen wie Mimic ergänzt, das Bildschirminhalte als interaktiven Film aufzeichnet. Das Resultat lässt sich wiederum mit Flare in eine digitale Dokumentation einbetten. Beispiele dafür liefert die Software gleich mit, etwa in Form eines rund 30-minütigen Tutorials. Dieses liegt allerdings nur auf englisch vor, während Flare selbst mittlerweile mit einer deutschen Benutzeroberfläche aufwartet.

Allerdings, am komplexen Aufbau hat die Übersetzung nichts geändert. Das Ein-Fenster-Konzept wurde beibehalten. Der Übersicht halber empfiehlt sich deshalb ein Bildschirm mit einer Diagonale von mindestens 20 Zoll. Die verschiedenen Einstellungen eines Projekts, etwa für den Import oder die Ausgabe, werden im zentralen Mittelteil und nicht über separate Dialogfenster durchgeführt. Den gleichen Platz beanspruchen die Editoren für die einzelnen Dokumente. In einer Spalte, die standardmässig am linken Bildschirmrand anzutreffen ist, zeigt Flare entweder die Projektorganisation oder aber den Topic-Explorer an.

Erstere beinhaltet sämtliche Einstellungen, etwa für Inhaltsverzeichnis oder Import und Ausgabe. Zweiterer listet die Ordnerstruktur mit den eingebundenen Dateien auf.

Die Benutzeroberfläche von Flare erlaubt zwar ein flottes Arbeitstempo. Dieses jedoch will mit einem recht hohen Einarbeitungsaufwand zuerst einmal verdient werden. Immerhin hat Herstellerin Madcap nicht an der Dokumentation gespart. Neben einem Handbuch im PDF-Format und dem Einführungsvideo steht zusätzlich eine kontextsensitive Hilfe bereit. Sie wird in einem ausblendbaren Bereich des Programmfensters angezeigt.

Flare übernimmt den Abschluss in der Produktionskette für digitale Dokumentationen. Entsprechend kann die Software nicht nur neue Hilfetexte erstellen, sondern auch bestehende Unterlagen importieren. Dabei zeigen sich die selben Schwächen wie schon bei den Vorgängerversionen. Der direkte Import über den entsprechenden Menübefehl ist auf Word- und Frame-Maker-Dokumente beschränkt. Einzelne HTML-Dateien müssen von Hand in den Projektordner auf der Festplatte verschoben werden, damit Flare darauf zugreifen kann. Weiteren Formaten, wie etwa RTF (Rich Text Format), verweigert die Hilfesoftware ihre Unterstützung.

Dafür versteht sich Flare mit Open-XML aus Microsoft Office 2007. Dieses, respektive dessen Textverarbeitung Word 2007, ist schon fast zwingende Voraussetzung, um produktiv mit der Madcap-Software zu arbeiten. Denn für Vorlagen im Open-XML-Format bietet Flare eine einfache Synchronisationsmöglichkeit. Änderungen an den Ursprungsdateien werden bei der Ausgabe in einem Hilfeformat auf Wunsch mitberücksichtigt. Das erlaubt es, Korrekturen an einer zentralen Stelle vorzunehmen und die Arbeit mit Flare auf die Formatierung und Aufbereitung zu beschränken.

Beim Import von Word-Dokumenten, auch in älteren Versionen, stehen zahlreiche praktische Optionen bereit. So lassen sich lange Texte automatisch auf verschiedene Hilfeseiten verteilen, entweder aufgrund der Länge oder anhand von festgelegten Absatzvorlagen wie einem Titelformat. Eine Versionskontrolle, um verschiedene Fassungen von Dokumenten zu protokollieren, fehlt allerdings.

Bei Hilfetexten und Voreinstellungen setzt Flare voll und ganz auf XML (Extensible Markup Language). Importierte Dokumente werden in dieses Format konvertiert. Diese Offenheit hat ihre Vorteile. So ist es etwa möglich, Inhalte dynamisch aus Datenbanken zu generieren oder Dokumente per Skript zu manipulieren. Die Formatierung erfolgt über CSS (Cascading Style Sheets), die als separate Dateien vorliegen. Inhalte und Formatierung sind also getrennt, was dem aktuellen Stand der Technik entspricht und schnelle, Dokumenten-übergreifende Anpassungen möglich macht. Über entsprechend angepasste Stilvorlagen lassen sich zudem die Eigenschaften unterschiedlicher Ausgabegeräte berücksichtigen.

Für CSS- wie für XML-Dateien bietet Flare einen passenden Editor, wobei nur Grundkenntnisse der zugrunde liegenden Tags notwendig sind, etwa, um eine Stilvorlage für ein Absatzformat anzulegen. Der XML-Editor entspricht von der Bedienung her einer Textverarbeitung. Einzelne Blöcke lassen sich ein- und ausblenden. Und Variablen nehmen häufig wiederkehrende Inhalte auf, die sich bei Bedarf schnell anpassen lassen. So könnte etwa die Telefonnummer des Unternehmens als Variable gespeichert werden. Im Falle einer Änderung müsste die Anpassung nur an einer zentraler Stelle erfolgen.

Ist die Hilfe samt Inhaltsverzeichnis und Index einmal erstellt, bietet Flare verschiedene Ausgabemethoden. Hier stehen Windows-spezifische Formate im Vordergrund. Die Software generiert per Knopfdruck komprimierte HTML-Hilfen im Dotnet- und Windows-eigenen Format wie auch Web-taugliche HTML-Dateien. Dagegen fehlt die Möglichkeit, direkt PDF-Dokumente zu erzeugen. Hierfür muss der Umweg über Frame-Maker oder Word 2007 beschritten werden. Wenn die aktuelle Fassung der -Microsoft-Textverarbeitung samt kostenlosem Addon für PDF- und XPS-Ausgabe (XML Paper Specification) installiert ist, untersützt auch Flare die Ausgabe in diesen beiden Formaten. Es wäre allerdings wünschenswert, wenn Flare dies ohne externe Hilfe bewerkstelligen könnte.

In einer Umgebung mit Office 2007 vereinfacht Flare den Aufbau von digitalen Anleitungen aller Art. Die Software bietet die nötigen Funktionen für die Erzeugung elektronischer Hilfestellungen und lässt zusammen mit Word 2007 diesbezüglich kaum Wünsche offen. Mit XML als Basisformat und CSS für die Formatierung gestaltet sich die Integration von Anleitungen in den Intranet- oder Webauftritt denkbar einfach. Es ist durchaus möglich, den statischen Teil mit Flare aufzubauen. Auf der Negativseite stehen der recht hohe Einarbeitungsaufwand und die bescheidenen Import- und Export-Möglichkeiten ohne Word 2007. So hinterlässt Flare auch ein Jahr und zweieinhalb Versionen nach dem Start einen gemischten Eindruck.

Fakten & Bewertung

Herstellerin: Madcap Software

Preis: Umgerechnet 1100 Franken

Vorteile: In Zusammenarbeit mit Word 2007 gute Integration in Abläufe, passender -Funktionsumfang, offenes XML-Format

Nachteile: Lernkurve recht steil, Benutzeroberfläche etwas verwirrend, keine direkte PDF-Unterstützung

www.madcapsoftware.com