tekom-Jahrestagung 2012 - ActiveDoc

Content Management
CM 4
Partnerpräsentation
Software-Dokumentation unter
Zeitdruck – Oberfläche, Online-Hilfe
und Handbuch aus einem Guss
Julia Schairer, Dürr Dental AG, Bietigheim-Bissingen
Thiemo von Gillhaußen, Fischer Computertechnik GmbH, Radolfzell
Software-Anleitungen stellen das Redaktionsteam immer wieder vor
neue Herausforderungen: Zeitnah zum Code-Freeze der Software muss
die Anleitung sowohl als kontextsensitive Online-Hilfe als auch als
Handbuch bereitgestellt werden.
Der Vortrag zeigt, welchen Weg die Technische Redaktion und die Software-Entwicklung
von Dürr Dental für die neue Software-Generation
gemeinsam gehen, um die Software-Oberfläche und Anleitungen effizient
und hochwertig zu erstellen.
PDF-Handbuch in
18 Sprachen
Software-Texte
vom Entwickler
Ausgangspunkt
Das Medizintechnik-Unternehmen Dürr Dental entwickelt und produziert
neben verschiedensten Geräten auch Software, z. B. eine Imaging-
Software, mit der Röntgen- und Videobilder erstellt, verwaltet und bearbeitet
werden können. Die Anwender der Software sind Zahnärzte und
Zahnarzthelferinnen.
Das Handbuch mit rund 170 Seiten und ca. 300 Screenshots wurde
bisher in InDesign in 18 Sprachen erstellt und im PDF-Format mit
wenigen Sprungmarken in die Software eingebunden. Die Erstellungszeit
des Handbuchs war auf den Testzeitraum der Software (6 Wochen)
begrenzt. Deshalb wurden die Screenshots nur in Deutsch und Englisch
erstellt und die Sprungmarken, die manuell in die einzelnen PDFs eingepflegt
werden mussten, auf ein Minimum begrenzt.
Die Oberflächen-Texte der Software erstellten die Software-Entwickler
während der Programmierung, auf Konsistenz und Verständlichkeit
wurde dabei nur marginal geachtet. Die Lokalisierung erfolgte durch
Export und Import von Excel-Tabellen.
Mit der neuen Software-Generation, einer vollständigen Neuentwicklung,
und der Einführung des XML-Redaktionssystems TIM-
RS ® Professional stiegen auch die Ansprüche und Wünsche an die
Software-Dokumentation.
Anleitungen mit XML erstellen
Im Redaktionssystem TIM-RS ® Professional erfolgt die Erfassung redaktioneller
Inhalte vollständig auf Basis von XML. Damit werden die Inhalte
Layout-neutral erfasst, unabhängig von deren Weiterverarbeitung.
Aus der gemeinsamen Datenbasis werden heute sowohl InDesign-Dokumente
(PDF) als auch die neue Software-Hilfe als HTML-Applikation
mit Navigation, Suche und Index in das Format XLIFF publiziert.
38
tekom-Jahrestagung 2012