Heraus­forderung

Die Ausgangssituation bei der Fujitsu Enabling Software Technology GmbH war gekennzeichnet durch die typischen Herausforderungen im Bereich der Produktdokumentation: steigende Volumina und zunehmende Komplexität, getrieben durch eine steigende Anzahl von Versionen und Varianten, hohe Qualitätsanforderungen an die Dokumentation als Produktkomponente, verkürzte Entwic lungszeiträume, unterschiedliche Ausgabeformate und die Notwendigkeit zur Integration mit dem Entwicklungsprozess und dem Produkt selbst.

Bereits vor Beginn des Projektes nutzte die Fujitsu Enabling Software Technology GmbH viele Vorteile des Single-Source-Publishing mit Hilfe des DITA-Standards für die Dokumentation: einmal erstellte Inhalte werden mehrfach in unterschiedlichen Dokumenten verwendet, der Publizierungsprozess ermöglicht die Ausgabe in verschiedenen Formaten (Eclipse Help, HTML, PDF).
Da die Verwaltung der Dokumentation immer komplexer wurde, stieg der Bedarf für ein Redaktionssystem, das die Verwaltung der Dokumentationsprojekte optimal unterstützt und sich dennoch nahtlos in den bestehenden Entwicklungsprozess integrieren lässt.

Bereits vorhandene Inhalte basierten auf einer älteren Version des DITA-Standards und sollten auf den aktuellen Stand gehoben werden. Da das Redaktionsteam seit längerem XMetaL als Editor einsetzte, sollte dieser möglichst beibehalten werden. Auch der seit langem etablierte Publikationsprozess sollte (vorerst) erhalten bleiben.

Lösung

Als Antwort auf diese vielseitigen Herausforderungen wählte die Fujitsu Enabling Software Technology GmbH nach umfangreichem Testbetrieb die Software DITAworks von *instinctools.

 

DITAworks ist eine Software, mit der unterschiedliche Arten von Dokumentation wie z.B. Handbücher, Schulungsmaterial, Prozessbeschreibungen oder Online-Hilfen nach dem Single-Source-Prinzip auf DITA-Standard erstellt und verwaltet werden können. DITAworks unterstützt den gesamten Lebenszyklus der Dokumentation von der Modellierung über die Redaktion bis zur Publikation. Einmal erstellte Inhalte werden in unterschiedlichem Kontext wiederverwendet und können in diversen Formaten wie z.B. XHTML, PDF, RTF, Eclipse Help, DocBook publiziert werden.

 

Bei der Fujitsu Enabling Software Technology GmbH wird die DITAworks-Lösung für Eclipse eingesetzt, die zusätzlich spezielle Funktionen für die Dokumentation von EclipseAnwendungen bietet.

 

Vorhandene Inhalte und das Modell wurden sorgfältig analysiert. Empfehlungen für eine Migration auf den neusten DITA-Standard und die Integration mit der dem vorhandenen Entwicklungs- und Publikationsprozess sowie dem XMetaL-Editor wurden erarbeitet. *instinctools erledigte die Umsetzung der Empfehlungen in Absprache mit der Fujitsu Enabling Software Technology GmbH.

Ergebnis

Nach Migration der vorhandenen Inhalte auf den neusten DITA-Standard und deren Übernahme in DITAworks, steht der weiteren Bearbeitung mit Hilfe der komfortablen Möglichkeiten, die DITAworks bietet, nichts mehr im Wege

 

Die DITAworks-Lösung für Eclipse Help adressiert die zentralen Herausforderungen beim Dokumentieren von Eclipse RCP-Anwendungen „out-of-the box“. Da die Fujitsu Enabling Software Technology GmbH bezüglich Migration und Integration spezielle Anforderungen hatte, unterstützte *instinctools
bei der Implementierung. Das Redaktionsteam der Fujitsu Enabling Software Technology GmbH ist nun für die weitere Dokumentation ihrer Anwendungen bestens gerüstet.

Mehr zu DITAworks finden Sie hier: ditaworks.de

Wichtige Merkmale

Die Integration mit dem Entwicklun sprozess ist erfolgt
Spezielle Transformationen für Eclipse Help stehen zur Verfügung Spezielle Validierungen für Eclipse Help sind vorhanden
Mit der DITA Spezialisierung für Eclipse Help können Eclipse Help-Ergebnisse wie z.B. Contexts, Live Actions und Cheatsheets definiert werden
Ein Plug-in für die Eclipse IDE ermöglicht die Zuordnung der Help Contexts und Synchronisierung mit dem Quellcode
ID Wizards helfen den Dokumentations und Entwicklungsteams bei der Synchro isierung Dynamisches Context ID Mapping wird unterstützt (DTP-Ansatz)
Die technischen Redakteure arbeiten mit ihrem bevorzugten Editor
Bereits vorhandene Eclipse Help Plug-ins können importiert werden.

Haben Sie eine ähnliche Projektidee?

Kontaktieren Sie uns – und erhalten Sie für Ihr Projekt einen Kostenvoranschlag gratis!