Wie parson das Hamburger Unternehmen EyeC GmbH bei der Umstellung der Technischen Dokumentation auf DITA-XML unterstützte
Die Technische Dokumentation bei der EyeC GmbH war lange klassisch aufgebaut: Handbücher wurden layoutbasiert in InDesign erstellt. Was zunächst gut funktionierte, wurde mit wachsender Produktvielfalt zunehmend zur Herausforderung – vor allem bei Varianten und der Wiederverwendung von Inhalten.
Gemeinsam mit parson stellte die EyeC GmbH daher auf eine DITA-basierte Dokumentation um. Ziel ist es, eine strukturierte und modulare Technische Dokumentation aufzubauen, die langfristig effizient gepflegt und erweitert werden kann.
Bei der Umstellung auf DITA-XML erarbeiteten parson und die EyeC GmbH eine neue Informationsarchitektur, überführten bestehende Inhalte in eine topic-basierte Informationsarchitektur und etablierten einen durchgängigen Publishing-Workflow für WebHelp und PDF.
Ausgangssituation: layoutbasierte Dokumentation in InDesign
Die Technische Dokumentation bei der EyeC GmbH wurde bislang überwiegend mit InDesign erstellt und war stark auf Layout ausgerichtet. Das bedeutete: Inhalte waren eng an einzelne Dokumente gebunden und ließen sich nur schwer wiederverwenden. Mit zunehmender Komplexität der Produkte wurde genau das zum Problem. Inhalte mussten mehrfach gepflegt werden, Varianten waren aufwendig umzusetzen, und Änderungen zogen oft manuelle Nacharbeit nach sich.
Ziel: Einführung einer modularen Dokumentation mit DITA
Die EyeC GmbH wollte die Dokumentation grundlegend neu aufstellen. Eine moderne, modulare Dokumentation auf der Basis von DITA-XML sollte entstehen. Ziel war es zudem, die Technische Dokumentation zu modernisieren und zukunftssicher auszurichten. Im Mittelpunkt standen dabei:
- Inhalt und Darstellung sauber trennen
- Topic-basierte Dokumentation einführen
- Inhalte modular aufbauen und wiederverwenden
- Varianten besser steuern
- Mehrere Ausgabeformate aus einer Quelle erzeugen (Single Source Publishing)
Neben PDF-Dokumenten sollte auch eine moderne WebHelp auf Basis von DITA entstehen. Darüber hinaus wollte die EyeC GmbH internes Know-how für die Arbeit mit DITA-XML und entsprechenden Tools wie Oxygen XML Editor weiter ausbauen.
Vorgehen
Ziele und Rahmenbedingungen. Zu Beginn analysierte parson gemeinsam mit der EyeC GmbH die bestehende Dokumentationslandschaft und definierte Ziele sowie Rahmenbedingungen. Dabei wurde insbesondere untersucht, wie sich die vorhandene Technische Dokumentation in eine strukturierte Dokumentation überführen lässt – als Grundlage für eine moderne Informationsarchitektur auf der Grundlage von DITA-XML.
Dokumentationsanalyse. In Workshops mit dem Redaktionsteam analysierten die parson-Expert:innen die vorhandenen Inhalte. Im Mittelpunkt standen die Struktur der Dokumentation, die Modularisierung der Inhalte und die Anforderungen an zukünftige Ausgabeformate im Kontext einer DITA-Dokumentation. Das Ergebnis: eine klare, tragfähige DITA-Struktur als Grundlage für alle weiteren Schritte.
Wissen aufbauen. Ein wichtiger Bestandteil des Projekts war der Wissenstransfer. Das Redaktionsteam der EyeC GmbH sollte künftig eigenständig mit DITA-XML und der neuen modularen Dokumentation arbeiten können.
Lösung: modulare Dokumentation auf Basis von DITA-XML und Publishing mit dem Oxygen XML Editor
Für die Umsetzung kam der Oxygen XML Editor zum Einsatz, ein etabliertes Werkzeug für DITA-XML und strukturierte Dokumentation. Im Projekt wurden unter anderem folgende Maßnahmen umgesetzt:
- eine klare DITA-Ordnerstruktur aufgebaut
- standardisierte Topic-Strukturen für verschiedene Inhaltsarten definiert, z. B. für Aufgaben
- ein Publishing-Workflow eingerichtet
- eine WebHelp für die HTML-Ausgabe der Dokumentation auf der Website erstellt
- eine Vorlage für PDF-Publishing entwickelt
Damit schuf die EyeC GmbH die Grundlage für eine skalierbare und zukunftssichere strukturierte Dokumentation.
Ergebnis: skalierbare DITA-Dokumentation und moderne WebHelp-Ausgabe
Das Redaktionsteam der EyeC GmbH arbeitet nun mit einer modernen DITA-Informationsarchitektur und klar strukturierten Inhalten. Konkret verfügt das Team über:
- eine definierte DITA-Struktur für zukünftige Inhalte
- eine moderne WebHelp als Online-Ausgabeformat
- optimierte PDF-Ausgaben aus derselben Quelle (Single Source Publishing)
- internes Know-how für DITA-XML und strukturierte Dokumentation
Die Technischen Redakteur:innen der EyeC GmbH erstellen und pflegen ihre Inhalte nun direkt im Oxygen XML Editor.
Ausblick
Nach der erfolgreichen Einführung der DITA-Dokumentation plant die EyeC GmbH weitere Schritte zur Modernisierung der Technischen Dokumentation. Ein möglicher nächster Schritt betrifft die Entwicklerdokumentation, die aktuell mit LibreOffice erstellt wird. Künftig soll geprüft werden, ob sich eine Kombination aus folgenden Ansätzen sinnvoll integrieren lässt:
- Markdown-basierte Entwicklerdokumentation
- HTML-Publishing
- Integration in eine strukturierte Dokumentation
So kann die EyeC GmbH ihre Dokumentationsstrategie langfristig weiter vereinheitlichen und die Technische Dokumentation weiter modernisieren.
Mit parson konnten wir unsere Technische Dokumentation erfolgreich auf DITA-XML umstellen. Besonders wertvoll war für uns die Kombination aus methodischer Beratung und praktischem Know-how bei der Umsetzung. So konnten wir eine modulare Dokumentationsstruktur aufbauen, die wir heute eigenständig weiterentwickeln.
Finden Sie Ihre aktuelle DITA-Lösung!
Über EyeC GmbH
EyeC bietet schnelle, präzise und benutzerfreundliche Systeme für die Artwork- und Druckinspektion. Als einziger Anbieter auf dem Markt garantiert EyeC die Produktqualität über den gesamten Herstellungsprozess hinweg.