RoboHelp oder Author-it - Eine Entscheidungshilfe

Transkript

1 RoboHelp oder Author-it - Eine Entscheidungshilfe Von Cornelia Rademacher, eolas informationsdesign gmbh Eine gute Dokumentation gehört zur Software wie ein Fotoapparat in die Reisetasche. Nur: Welcher Apparat eignet sich am besten für meine Reise? Brauche ich unterschiedliche Aufnahmemodi? In welchen Formaten will ich meine Fotos später veröffentlichen? Ähnliche Fragen stellen sich auch bei der Wahl zur Aufnahme der Dokumentation: Welches Hilfe-Tool passt am besten zur Arbeitsweise unserer Firma? Wie sieht die Arbeit damit aus? Was kann es? Und was kommt am Ende dabei heraus? Wenn Sie verschiedene Ausgabeformate aus ein und demselben Inhalt erzeugen möchten, ist ein Single-Source-Tool das richtige für Sie. Damit können Sie die Dokumentation konsistent halten und Kosten sparen. Nun haben Sie die Qual der Wahl, denn mittlerweile bietet der Markt eine Vielzahl an Hilfe- Tools, von denen die meisten laut Hersteller die optimale Single-Source-Lösung sind. Zwei davon, Author-it und RoboHelp, die von eolas informationsdesign gmbh in unterschiedlichen Projekten eingesetzt werden, werden in diesem Artikel genauer betrachtet. Der Vergleich der beiden Tools bezieht sich auf die Basis-User-Lizenz von Author-it 5.5 und auf RoboHelp 9. Folgende Aspekte werden zum Vergleich herangezogen: Tool-Architektur Arbeiten mit dem Tool Ausgabe Paralleles Arbeiten an einem Projekt Übersetzung Umstieg von anderen Tools Review-Prozesse Fazit Eine Zusammenfassung des Vergleichs finden Sie im Fazit.

2 RoboHelp oder Author-it - Eine Entscheidungshilfe 2/11 Tool-Architektur Grundkonzept Author-it ist eine Mischung aus einem XML-basierten Hilfe-Tool und einem datenbankgestützten Content Management-System. RoboHelp ist ein Hilfe-Tool auf XHTML-Basis. In beiden Tools werden die Inhalte mithilfe eines WYSIWYG-Editors in Topics erfasst und zum Generieren der Ausgabeformate in Bücher bzw. in Inhaltsverzeichnisse eingefügt. Beide Tools ermöglichen das Arbeiten mit Textbausteinen und Variablen, um häufig wiederkehrende Elemente in die Topics einzufügen. Diese Inhalte müssen nur einmal erfasst werden und können dann zentral im Textbaustein oder in der Variable aktualisiert werden. Ein weiteres Element des Single-Sourcing besteht darin, Textpassagen, Grafiken oder auch komplette Topics aus Ausgabeformaten auszuschließen. So können Sie beispielsweise Textpassagen für verschiedene Benutzergruppen verfassen und diese je nach Bedarf einoder ausblenden. Hier gehen die beiden Tools sehr unterschiedliche Wege: Author-it verfolgt einen streng objektorientierten Ansatz und steuert das Einbinden der Objekte in Ausgabeformate über Templates auf allen Objektebenen sowie über Varianten. Die Anzeige von Topics in Ausgabeformaten kann zudem über Regeln im Publikationsprofil gesteuert werden. RoboHelp steuert die Anzeige von Texten und Grafiken oder auch Topics über Bedingungen, die man zuweisen kann. Damit bietet RoboHelp einen Ansatz, der sich leichter erschließt, und man kann nach kurzer Einarbeitungszeit die ersten Hilfen erstellen und generieren. Bei Author-it braucht es mehr Einarbeitungszeit und Vorbereitungsaufwand, um die verschiedenen Objekte und ihre Einsatzmöglichkeiten zu verstehen und um die Templates für das eigene Projekt anzupassen. Dafür bietet Author-it mehr Möglichkeiten für die Differenzierung der Objekte in verschiedenen Ausgaben. Funktionsumfang und Lizenzierung Author-it ist modular aufgebaut das System reicht von der Einzelplatzlösung bis zum umfangreichen Redaktionssystem mit Zusatzmodulen. Dementsprechend variieren auch die Lizenzkosten.

3 RoboHelp oder Author-it - Eine Entscheidungshilfe 3/11 Zu den Kosten einer Author-it-Lizenz kommen noch einmal 19% jährlich für einen Maintenance-Plan hinzu, der Support und Upgrades beinhaltet. Im ersten Jahr ist der Abschluss des Maintenance-Plans verpflichtend. Die Basis-User-Lizenz von Author-it 5.5 beinhaltet den Editor, die Verwaltung, Import/Export, die Publikation der Ausgabeformate und das Workflow-Management. RoboHelp 9 beinhaltet den Editor, den Projektmanager, die Projekteinrichtung, die Importfunktion, das Einzelquellenlayout für die Ausgabeformate, den Ressourcenmanager und diverse Pods (Fenster) zur Anzeige und zum Verwalten von Objekten. Zudem ist Screen- Capture integriert, sodass Sie aus RoboHelp direkt Screenshots erstellen können. Die Kosten für RoboHelp9 und die Basis-User-Lizenz von Author-it (ohne Maintenance Plan) bewegen sich ungefähr auf dem gleichen Niveau. Installation RoboHelp 9 muss auf den einzelnen Rechnern der Nutzer installiert sein und nach 30 Tagen aktiviert werden. Dabei wird die IP-Adresse des Rechners erfasst und die Lizenz dem Computer zugeordnet. Die Aktivierung kann ausschließlich online erfolgen. Sie können RoboHelp 9 also nur auf Rechnern nutzen, auf denen Sie auch einen Internetzugang haben. Für paralleles Arbeiten an einem Projekt ist ein Datenbankserver nötig. Author-it muss auf den einzelnen Rechnern der Nutzer installiert sein. Bevor Sie in Authorit 5 ein Projekt öffnen können, müssen Sie dem Projekt im Author-it-Administrator den Lizenzschlüssel zuordnen. Bei mehr als fünf Nutzern ist ein Datenbankserver nötig. Arbeiten mit dem Tool Benutzerfreundlichkeit Toolarchitektur Author-it mit seinem konsequent objektorientierten Ansatz weist die komplexere Struktur auf und benötigt diesbezüglich mehr Einarbeitungszeit als RoboHelp. Bedienoberfläche Mit Version 5 wurde in Author-it die Oberfläche an das Design der Microsoft Office Programme ab Office 2007 angelehnt, sodass sich die Bedienung des Programms für Office-

4 RoboHelp oder Author-it - Eine Entscheidungshilfe 4/11 Anwender relativ schnell erschließt. Die Oberfläche steht allerdings nur in englischer Sprache zur Verfügung. RoboHelp ist ebenfalls an Microsoft Office-Programmen orientiert und somit leicht zugänglich. Die Vielzahl an Pods (Fenstern) und ihre Nutzungsmöglichkeiten braucht ein bisschen Einarbeitungszeit. Hilfe Die Author-it-Hilfe steht nur in englischer Sprache zur Verfügung. Aus dem Programm heraus können Sie auch den Author-it-Knowledge Center aufrufen, falls Sie auf dem Rechner einen Internetzugang haben. Hier finden Sie Videos und Tutorials sowie einen Link zum User Forum. In RoboHelp finden Sie eine auf Fensterebene kontextsensitive Hilfe in deutscher Sprache. Aus dem Programm heraus können Sie auch den Online-Support in englischer Sprache aufrufen. Inhalte erstellen Text erfassen Beide Tools arbeiten mit einem WYSIWYG-Editor. In RoboHelp ist ein Wechsel zwischen der HTML-Ansicht und der Entwurfsansicht möglich, ebenso wie direktes Eingreifen in den HTML-Code. Dies ist teilweise bei Listenformaten auch nötig, da verschachtelte Listen mit Listenfortsetzungen über den WYSIWYG-Editor nicht in sauberem HTML-Code erzeugt werden. Um ein korrektes Format in den Ausgabeformaten zu erhalten, muss hier im HTML-Code nachgearbeitet werden. Bilder, Textbausteine, Hyperlinks Bilder, Textbausteine und Hyperlinks können in beiden Tools über Drag&Drop in den Editor gezogen und somit in das Topic eingefügt werden. Die Textbausteine nehmen dabei das Absatzformat des Topics an. In Author-it ist es zudem möglich, im Textbaustein selbst Zeichenformate über den Editor zuzuweisen, die dann auch im Topic in allen Ausgabeformaten richtig angezeigt werden. In RoboHelp funktioniert dies nur über den Umweg, den Text aus einem Topic heraus als Textbaustein zu speichern.

5 RoboHelp oder Author-it - Eine Entscheidungshilfe 5/11 Berichte und Informationen über die Verwendung der Objekte In RoboHelp gibt es eine Reihe von Berichten, die Ihnen das Verwalten der Topics und Objekte erleichtern, beispielsweise einen Bericht über fehlerhafte Verknüpfungen oder über Bilder, die nicht verwendet werden. Auch über die Pods wie die Themenliste erhält man auf einen Blick Informationen, beispielsweise über den Status, die Zuordnung zu einem Inhaltsverzeichnis oder die Bedingungstags eines Topics. Zudem ist in den Objekteigenschaften aufgeführt, wo das Objekt verwendet wird. In Author-it erhalten Sie Informationen über die Verwendung der Objekte. Im Author-it- Administrator gibt es einen Report zu den verlinkten Objekten, in dem man sehen kann, welche Objekte nicht gefunden werden. Ausgabe Folgende Ausgabeformate werden unterstützt: Ausgabeformat Author-it RoboHelp Word ja ja PDF ja ja HTML ja ja XHTML ja ja WebHelp ja ja WebHelp-Pro nein ja FlashHelp nein ja FlashHelp-Pro nein ja Microsoft-HTML-Help (CHM) ja ja JavaHelp ja ja OracleHelp ja ja XML ja ja Adobe AIR nein ja epub nein ja Author-it DITA ja -

6 RoboHelp oder Author-it - Eine Entscheidungshilfe 6/11 Vorbereitung der Ausgaben Die Gestaltung der Ausgaben wird in Author-it über die Objekt-Templates definiert. Der Editor bietet für alle Objekte Templates an, die Sie für die eigenen Projekte anpassen können. In RoboHelp erfolgt die Gestaltung der Online-Hilfe über HTML-Masterseiten für Kopf- und Fußzeile, Skins für die Gestaltung der Navigation und ein CSS für die Absatz- und Zeichenformate sowie Listen und Tabellen. Es gibt eine Galerie mit vorgefertigten Skins, Sie können aber auch eigene Skins definieren. Für das CSS gibt es ein Standard-CSS, das aber nur wenige Formate enthält und für eigene Projekte angepasst werden muss. Für die Printausgabe muss für RoboHelp eine Word-Formatvorlage erstellt werden, deren Formate beim ersten Generieren des Einzelquellenlayouts den Formaten im RoboHelp-CSS zugewiesen werden. Die Anpassung der Formatvorlagen setzt in beiden Tools entsprechende Kenntnisse im Erstellen von Word-Formatvorlagen voraus. Für eine ausgefeiltere Gestaltung der Online- Hilfe sind CSS- und HTML-Kenntnisse hilfreich. Übernahme der Formate Absatz- und Zeichenformate werden in der Regel in beiden Tools korrekt in die Ausgabeformate übernommen. Bei RoboHelp erfordert dies für Listen und Textbausteine in der Erstellung mehr Aufwand und HTML-Kenntnisse, siehe Inhalte erstellen. Darstellung der Grafiken und Hyperlinks Grafiken und Hyperlinks haben in Author-it eine eigene Formatvorlage. Damit kann die Darstellung für die unterschiedlichen Ausgabeformate getrennt definiert werden. Diese Möglichkeit gibt es in RoboHelp nicht. Nachbearbeitung des Word-Dokuments Der Nachbearbeitungsaufwand für das Word-Dokument ist bei RoboHelp größer als bei Author-it. Bei der Generierung eines Word-Dokuments aus RoboHelp muss beispielsweise Folgendes im Word-Dokument nachgearbeitet werden: Kopf- und Fußzeilen aus der Wordvorlage werden von RoboHelp überschrieben und müssen im Word-Dokument angepasst werden. Bei Hyperlinks müssen nach dem Generieren im Word-Dokument die Seitenzahlen manuell eingefügt werden.

7 RoboHelp oder Author-it - Eine Entscheidungshilfe 7/11 Die Überschriftenformate müssen im Word-Dokument erneut zugewiesen werden, wenn die Überschriften im Word-Dokument nummeriert sein sollen. Author-it hingegen bietet mit den After Publish Macros die Möglichkeit, bestimmte Arbeitsabläufe durch Word-Makros nach dem Publizieren zu automatisieren. Paralleles Arbeiten an einem Projekt Paralleles Arbeiten ist mit Author-it problemlos möglich, wenn das Projekt auf einem für alle Beteiligten zugänglichen Laufwerk liegt. In Author-it selbst müssen nur im Administrator die Nutzer mit ihren Berechtigungen angelegt werden. Wenn ein Nutzer ein Topic öffnet, ist es für die anderen Nutzer gesperrt. Sobald das Topic gespeichert und geschlossen ist, ist es wieder für alle zugänglich. Um den Stand der Bearbeitung zu kennzeichnen, können im Author-it-Administrator verschiedene farbig markierte Releasestatus definiert werden. Die Benutzer können die Releasestatus beim Arbeiten im Editor zuweisen. Mit RoboHelp ist ein paralleles Arbeiten in Projekten auf einem Netzlaufwerk nicht möglich. Dafür ist RoboSource Control nötig (Bestandteil von RoboHelp9). Dazu müssen Sie zuerst eine SQL-Datenbank auf einem Server anlegen und das RoboHelp- Projekt in die Datenbank übertragen. Anschließend können Sie die Nutzer mit ihren Zugriffsrechten in RoboSource Control angelegen. Die Nutzer laden eine lokale Arbeitskopie aus der Datenbank herunter, die mit der Datenbank verknüpft ist. In der lokalen Arbeitskopie werden die Topics ausgecheckt und nach der Bearbeitung wieder eingecheckt. Während der Bearbeitung ist das Topic für andere Nutzer gesperrt. Nach der Freigabe wird das Topic mit einer neuen Version in der Datenbank gespeichert. Für die Anzeige des Bearbeitungsstatus gibt es in RoboHelp nur drei vordefinierte Status. RoboHelp bietet mit Version 9 die Möglichkeit, im Ressourcenmanager Grafiken, Mediaobjekte, Stylesheets oder Textbausteine in einem freigegebenen Ordner im Netzlaufwerk zu verwalten und mit den Projekten zu verknüpfen. Auf diese Weise können Aktualisierungen dieser Objekte in verschiedenen Projekten synchronisiert werden. Übersetzung Wenn Projekte übersetzt werden sollen, bietet Author-it eindeutig mehr. Man kann Inhalte nach bestimmten Kriterien, wie z. B. Änderungsdatum, Autor oder Releasestatus filtern

8 RoboHelp oder Author-it - Eine Entscheidungshilfe 8/11 und eine XML-Datei generieren. Das spart Kosten bei der Übersetzung. Mit dem Zusatz- ModulAuthor-it Localization Manager werden Objekte automatisch nach Änderungen gefiltert, in eine neue Library kopiert und eine übersetzungsrelevante XML-Datei generiert. In RoboHelp gibt es keine Unterstützung für Übersetzungen. Es ist allerdings möglich, die HTML-Dateien sowie alle weiteren benötigten Dateien, beispielsweise das Inhaltsverzeichnis, mit einem Translation Memory System zu übersetzen. Anschließend werden die Dateien in eine Kopie des Projekts importiert, in der die entsprechenden Spracheinstellungen vorgenommen wurden. Umstieg von anderen Tools In RoboHelp können Sie MIF- und FM-Dateien aus FrameMaker importieren. Zudem können Sie die Ausgabeversion einer Hilfe importieren, aber keine Einzeldateien im proprietären Dateiformat des Hilfe-Tools eines Drittanbieters. In Author-it können Sie RoboHelp-Projekte importieren sowie mit dem Zusatz- ModulAuthor-it 5 MIF-Importer die MIF-Dateien aus FrameMaker. Folgende Formate können in Author-it oder RoboHelp importiert werden: Import-Format Author-it RoboHelp Word ja ja PDF nein ja RTF ja ja HTML ja ja XML ja ja MS WinHelp ja ja MS HTML Help-Projekte ja ja FrameMaker Ja, wenn das Zusatz-Modul Author-it 5 MIF Importer installiert ist. ja RoboHelp-Projekte ja - DITA XML-Datei mit DITA-Templates DITA-Zuordnungsdatei, aber der DITA Open Tool Kit wird benötigt

9 RoboHelp oder Author-it - Eine Entscheidungshilfe 9/11 Review-Prozesse Review durch Nutzer, die ebenfalls eine Lizenz für das Tool haben In Author-it können Sie ein eigenes Format für Kommentare im Stylesheet definieren, dem Sie auch eine Farbe zuweisen können. Reviewer, die Zugriff auf das Projekt haben, können so ihre Kommentare direkt in die Topics schreiben. Eine komfortablere Methode bietet hier RoboHelp9. Sie können Kommentare und Korrekturen im Überarbeitungsmodus in die Topics einfügen und annehmen oder ablehnen, wie man es aus anderen Programmen kennt. Die Topics, in denen Änderungen vorgenommen wurden, werden im Review-Pod angezeigt und können von dort aus geöffnet werden. Voraussetzungen für das parallele Arbeiten siehe Paralleles Arbeiten an einem Projekt. In Author-it können Sie ein PDF mit Edit-Schaltfläche generieren und an die Review- Teilnehmer senden. Bei Klick auf die Edit-Schaltfläche im PDF öffnet sich der Topic-Editor und der Text kann bearbeitet werden. Dies setzt beim Reviewer allerdings Author-it- Kenntnisse und installierte Software voraus. Zudem können Sie in Author-it mit den Zusatzmodulen Author-it Live und Author-it Reviewer ein Web-basiertes Review durchführen. Dies ermöglicht ein gleichzeitiges Reviewen von Inhalten durch mehrere Reviewer. Alle Korrekturlesenden sehen die Änderungswünsche der anderen und können diese wiederum kommentieren. Der verantwortliche Redakteur steuert den Review-Prozess und entscheidet, welche Korrekturen und Kommentare übernommen werden. Review durch Nutzer, die keine Lizenz für das Tool haben Mit beiden Tools ist es möglich, ein Word-Dokument für das externe Review zu generieren und dort Änderungen im Überarbeitungsmodus vornehmen zu lassen. Diese Änderungen müssen jedoch anschließend manuell in den Editor eingepflegt werden. RoboHelp9 bietet zudem die Möglichkeit, ein PDF zum Review zu erzeugen, zur Kommentierung freizugeben und an den Review-Teilnehmer zu senden. Der Review-Teilnehmer benötigt dafür den kostenlosen Acrobat Reader ab Version 9. Voraussetzung für den Redakteur: Auf dem Rechner, von dem aus in RoboHelp9das PDF erzeugt werden soll, muss auch Adobe Acrobat 10 Pro oder die Technical Communication Suite 3 installiert sein. Das Review kann auch Web-basiert über einen eigenen Server oder über den Internetdienst von Acrobat durchgeführt werden.

10 RoboHelp oder Author-it - Eine Entscheidungshilfe 10/11 Das kommentierte PDF kann in RoboHelp importiert werden. Die Änderungen und Kommentare werden in einem Reviewfenster angezeigt. In den Topics werden die Änderungen und Kommentare im Änderungsmodus angezeigt und können so wie man es aus anderen Programmen kennt angenommen oder abgelehnt werden. Noch verbesserungswürdig: Die Struktur des Review-PDF wird über die Reihenfolge der Topics im Projektmanager bestimmt und nicht über die Gliederung der Inhaltsverzeichnisse. Dadurch geht bei Handbüchern der Überblick über den Aufbau der Dokumentation für den Reviewer verloren. Die Abstände zwischen den Wörtern und zwischen Wörtern und Satzzeichen werden im PDF nicht korrekt angezeigt, sodass es teilweise so aussieht, als wären ein paar Leerzeichen zu viel im Text. Beim Import des Review-PDF werden teilweise im Reviewfenster nicht alle geänderten und kommentierten Topics angezeigt, obwohl die Änderungen und Kommentare beim Importieren in die Topics übernommen werden. Fazit RoboHelp hat seine Stärken in den Online-Formaten und in der Unterstützung bei der Verwaltung der Projekte durch Berichte und Übersichten in den Pods. Zudem ist das Tool von seiner Grundstruktur her leichter zu erfassen als Author-it. Je differenzierter die Ausgabeformate sein müssen, desto mehr kann Author-it seine Stärken ausspielen. Die Differenzierungsmöglichkeiten sind größer und die Umsetzung in den Ausgabeformaten erfolgt korrekt. Für Projekte mit derartigen Anforderungen lohnt sich auch die längere Einarbeitungszeit in das Tool. Für paralleles Arbeiten an Projekten bietet Author-it den einfacheren Workflow, weil man das Projekt einfach in einem gemeinsamen Ordner im Netzlaufwerk bearbeiten kann. Beim Review durch Nutzer, die Zugriff auf das Projekt haben, bietet RoboHelp mit dem Überarbeitungsmodus die bessere Lösung. Beim Review durch Nutzer, die keinen Zugriff auf das Projekt und keine Lizenz für das Tool haben, kommt man bei beiden Tools nicht ohne Kosten für Zusatz-Module oder für die entsprechende Version von Acrobat Pro aus (es sei denn, man geht den klassischen Weg über ein Review im Word-Dokument). Der PDF- Workflow in RoboHelp ist noch verbesserungswürdig. Den Web-basierten Review-Prozess in Author-it haben wir noch nicht getestet. Für Übersetzungen bietet Author-it eine bessere Unterstützung als RoboHelp, auch ohne das Zusatz-Modul Localization Manager.

11 RoboHelp oder Author-it - Eine Entscheidungshilfe 11/11 Beide Tools haben also ihre Stärken und Schwächen, die es nun abhängig von Ihren Anforderungen und Unternehmensprozessen abzuwägen gilt. Nur so können Sie entscheiden, welches Hilfe-Tool sie letztlich in Ihre Doku-Tasche packen.