Das Unternehmen Unify setzt bei der Erstellung seiner Dokumentationen auf das XML-Format DITA, das aufgrund der einfachen Strukturierung und des modularen Aufbaus für umfangreiche Dokumentationen besonders geeignet ist. Für die Bearbeitung ist Adobe FrameMaker im Einsatz, die Publikation im Online-Hilfe Format wird mittels WebWorks ePublisher ausgeführt.
Einsatz von DITA
Bei Unify werden Dokumentationen inzwischen fast ausschließlich in DITA erstellt. Unify übernimmt bei der Struktur der DITA Map die überschaubare Gliederung in maximal vier Ebenen. So ergibt sich eine Unterteilung in Kapitel/Cluster, Themenbereiche, Konzept-Beschreibungen und Handlungsanweisungen (Tasks). Die Aufteilung ist hierarchisch, sodass sich Kapitel in verschiedene Themenbereiche untergliedern, die sich wiederum aus Themen zusammenzusetzen. Die Tasks übernehmen die beschreibende Funktion eines „How to …“, in denen <step> by <step> die einzelnen Anleitungsschritte angegeben werden.
Die Strukturierung in Cluster und Themenbereiche ist außerdem eine gute Grundlage, um im Rahmen des Worksplits die verschiedenen Topics für die Bearbeitung durch einzelne Redakteure aufzuteilen. Auf diese Weise wird gewährleistet, dass einzelne Cluster oder Themenbereiche von einem Redakteur bearbeitet und aktualisiert werden. Die gleichzeitige Bearbeitung eines Clusters oder Themenbereiches durch mehrere Redakteure hat sich bei Unify nicht bewährt.
Da der Einsatz von DITA und die darin definierten Struktureinheiten allein mitunter nicht ausreichend sind, ist die Einführung spezifisch definierter Klassen notwendig. Unify verwendet eigens angepasste Topic-Klassen auf verschiedenen Ebenen. So kommen bei der Dokumentationserstellung beispielsweise die zusätzlichen Topic-Klassen Overview Topic, Wizard Task oder Expert Task zum Einsatz.
Um nicht strukturierte Inhalte in neue DITA-Topics zu übernehmen, verwendet Unify das Tool MIF2Go. Die Inhalte werden hierbei jedoch nicht in die einzelnen Topic-Klassen zerlegt, sondern ausschließlich als Topic-Typ „Topic“ kategorisiert. Dies ist darauf zurückzuführen, dass in den unstrukturierten Templates keine semantischen Formate hinterlegt sind. So kann bei der Umwandlung durch MIF2Go nicht festgestellt werden, ob es sich beispielsweise um ein Konzept-Topic oder um ein Task-Topic handelt. Eine Nachbearbeitung ist daher unumgänglich.
Sirius CMS von Acolada
Um die enorme Datenmenge übersichtlich zu verwalten und zu pflegen, nutzt Unify die Vorteile des Content Management Systems Sirius der Acolada GmbH. Dieses erlaubt die übersichtliche Darstellung des projektbezogenen Topicpools mit ca. 50.000 Topics, aus denen knapp 19 Handbücher in bis zu 16 verschiedenen Sprachen erstellt werden.
Das CMS Sirius von Acolada beinhaltet ein DITA-Modul, das die Verwaltung und Pflege von DITA-Projekten und die Automatisierung von Prozessen ermöglicht. Für die optimale Nutzung von Sirius können zusätzliche kundenspezifische Skripte erstellt werden, die den individuellen Workflow unterstützen, vereinfachen und automatisieren.
Unify nutzt verschiedene Automap Skripte, die es ermöglichen, aus einer DITA-Map sogenannte DITA-Composites zu generieren. Diese können anschließend in FrameMaker mittels eines FrameMaker-Plugins zu einem FrameMaker-Buch generiert werden, das für die Publikation mit WebWorks ePublisher benötigt wird.
>>> Informationen über Acolada Sirius
Bearbeitung in FrameMaker
Aus dem Sirius CMS heraus können Redakteure von Unify direkt zu Adobe FrameMaker wechseln, um eine einzelne Datei zu bearbeiten. Ein Plugin in FrameMaker erlaubt es den Redakteuren, Bilder aus der Asset-Datenbank von Sirius CMS in FrameMaker einzubinden.
Für die Bearbeitung und Erstellung ihrer Dokumentationen verwendet Unify derzeit Adobe FrameMaker10 und DITA 1.1, das um eine eigens angelegte Applikation für Unify ergänzt wird. Diese erweitert die Standardeinstellungen in FrameMaker vor allem in Bezug auf die EDD, in der mittels des Attributs xml.lang die sprachabhängigen Präfixe des Templates definiert werden können. Obwohl Adobe FrameMaker über zahlreiche Voreinstellungen für Templates verfügt, sind diese für Unify kaum ausreichend.
Variablen
Für das Einfügen zum Beispiel des Produktnamens und der Sachnummer verwendet Unify in der DITA-Map zusätzliche XML-Elemente, die nicht DITA-konform sind. Beim Erzeugen eines FrameMakers-Buchs werden diese Elemente als FrameMaker-Variablen übernommen.
Übersetzungsmanagement
Für die Publikation einer Dokumentation in mehrere Sprachen ist es notwendig, alle betreffenden Dokumente in allen Sprachen auf den neuesten Stand zu bringen. Die zu einer Dokumentation gehörigen Dokumente und Module (DITA-Maps, Concepts, Task usw.), die seit der letzten Übersetzung geändert wurden, werden mithilfe des Sirius CMS Übersetzungsmanagement in einem Übersetzungspaket zusammengefasst. Dabei wird zwischen Komplett- und Delta-Übersetzung unterschieden. Handelt es sich um eine Delta-Übersetzung, werden ausschließlich diejenigen Dokumente in die zip-Datei übernommen, die seit der letzten Übersetzung geändert wurden.
Das Übersetzungspaket besteht aus einer zip-Datei, die alle zu übersetzenden Dokumente nach Sprachen sortiert enthält. Diese zip-Datei wird an den Sprachendienst geliefert, der die Dokumente übersetzt und in gleicher Form wieder zurückliefert. Schließlich wird das Übersetzungspaket in das Sirius-CMS zurück importiert. Die Dokumentation kann von dort aus in den gewünschten Sprachen publiziert werden.
Publikation mittels WebWorks ePublisher
Für die Veröffentlichung der bearbeiteten Dokumentationen setzt Unify auf die umfangreichen Funktionalitäten des WebWorks ePublisher. Derzeit verwendet Unify ePublisher Express und Server 2011.1.
Mittels einer eigens konfigurierten Batch-Datei kann die Dokumentationspublikation per Knopfdruck ausgeführt werden. In der Batch-Datei sind Angaben zum Automap-Projekt hinterlegt. Dieses wiederum beinhaltet Angaben über das jeweils zu verwendende Stationery, das beim Publizieren mit WebWorks ePublisher genutzt wird. Die Batch-Datei ermöglicht außerdem die unterschiedliche Zuweisung von Logos bei Dokumentationen für verschiedene Firmen. Zu den Angaben im Automap-Projekt zählen Gruppennamen (Group Names), die den verschiedenen Büchern der Dokumentation entsprechen sowie Einstellungen zum Umgang mit bedingtem Text. Auch der Gebrauch von weiteren Variablen wird an diesem Schritt des Workflows berücksichtigt.
Für die Publikation als Online-Hilfe-Formate nutzt Unify vorwiegend die Formate WebWorks Help und MS HTML-Help (CHM). Um den Anforderungen mobiler Dokumentation gerecht zu werden, veröffentlicht Unify außerdem einen Teil seiner Dokumentationen bereits im responsiven HTML5-Format WebWorks REVERB.
>>> Informationen über WebWorks ePublisher
Bereitstellung als PDF-Dateien
Die zum Teil sehr umfangreichen Dokumentationen werden von Unify auch im PDF-Format publiziert, um Inhalte auch als druckfähige Version zur Verfügung zu stellen. Für die Generierung der PDF-Dateien greift Unify auf die entsprechenden Funktionalitäten in Adobe FrameMaker zurück.
Über Unify
Unify, bisher bekannt als Siemens Enterprise Communications, ist ein weltweit führendes Unternehmen für Kommunikationssoftware, und -services. Unser neuer Name steht für die Mission unseres Unternehmens: Wir vereinheitlichen die Kommunikationssysteme unserer Kunden. Durch die Synchronisierung von Technologien, ein angenehmes Anwendererlebnis und die nahtlose Integration von Kommunikation in geschäftliche Prozesse ermöglichen wir der ständig wachsenden Zahl mobiler Mitarbeiter eine intensivere und effektivere Zusammenarbeit. Damit verändert sich die Art und Weise wie Unternehmen kommunizieren und zusammenarbeiten nachhaltig – die Teamleistung wird verstärkt, das Geschäft belebt und die Business-Performance verbessert.
Aus seiner Siemens-Herkunft heraus setzt Unify auf verlässliche Produkte, Innovationen, offene Standards und Sicherheit als Grundlage für seine integrierten Kommunikations- und Netzwerklösungen, mit denen Unify 75 % der „Global 500“-Unternehmen beliefert. Der Einführung von „Project Ansible“ und die Vision einer dynamischen Plattform für Kommunikation und Zusammenarbeit machen Unify zum Marktführer. Unify ist ein Joint Venture der The Gores Group und der Siemens AG.
>>> Weitere Informationen über Unify
Weiterführende Links:
