1. Ausgewählte Diplom- und Masterarbeiten

Transkript

1 XML-ANWENDUNGEN IN DER TECHNISCHEN DOKUMENTATION Dr. Thomas Meinike Im ausgelaufenen Diplomstudiengang Kommunikation und Technische Dokumentation (KTD) sowie im neu etablierten Masterstudiengang Technische Redaktion und Wissenskommunikation (TRW) sind im Zeitraum seit dem letzten Forschungsbericht wiederum einige vom Autor betreute Abschlussarbeiten mit praxisorientierten Themen im XML-Umfeld entstanden. Kurze Zusammenfassungen von vier ausgewählten Arbeiten vermitteln einen Einblick in die Vielseitigkeit der modernen Dokumentationspraxis. Abschließend wird auf veröffentlichte Fachartikel und gehaltene Vorträge verwiesen. 1. Ausgewählte Diplom- und Masterarbeiten Stypka, Maren (Matrikel D-KTD 04, Praxisbetreuer: Herr Dr. G. Ratz) Untersuchungen zur strukturierten Dokumentation mit DITA im Bereich der Schienenfahrzeugtechnik (2009): Das Thema Single-Source-Publishing unter Verwendung von XML-Technologien wird in zunehmendem Maße für die Produzenten technischer Dokumentationen interessant. Die Autorin hat sich bei einem Dienstleister im Bereich der Schienenfahrzeugtechnik mit strukturierter Dokumentation beschäftigt. Ausgehend von existierenden XML-Standards wie SPEC 1000D, mumasy und DocBook erläutert sie Aufbau und Anwendung des noch relativ jungen Konzeptes DITA (Darwin Information Typing Architecture). Neben den für Inhaltsbausteine verwendeten Topics werden weitere Komponenten wie Maps und Metadaten diskutiert und Werkzeuge für die praktische Redaktionsarbeit mit DITA 132

2 behandelt: XML-Editoren, das frei verfügbare DITA Open Toolkit und die Anwendung Adobe FrameMaker in Version 8, welche eine integrierte DITA-Funktionalität bereit stellt. Etablierte Strukturierungsmethoden wie Funktionsdesign und Information Mapping werden ebenfalls betrachtet, da sich die modernen Strukturierungstechniken daran orientieren. Im praktischen Teil steht die Umsetzung des Benutzerhandbuchs für eine halbautomatische Kupplung im Mittelpunkt. Es werden die nötigen Schritte des DITA-Einsatzes im FrameMaker-Kontext herausgearbeitet und anschaulich dokumentiert. Würker, Sascha (Matrikel D-KTD 04, Praxisbetreuer: Dipl.-Wirtsch.-Ing. (FH) Rene Skorwider) XML-basierte Umsetzung von Vertriebsunterlagen (2008): IKS Kw/Ww KAT FPT Aw/Ao XML-Technologien sind integraler Bestandteil aktueller Dokumentationsprozesse. Neben der strukturierten Erfassung von Inhalten müssen optimale Abläufe ( Workflows ) zur Umsetzung von Medien im Print- und Online-Bereich gestaltet werden. Für einen Kunden der mittelständischen Firma I-TM Institut für Telekommunikation und Medien GmbH sollten vom Autor Vertriebsunterlagen auf XML-Basis produziert werden. Der theoretische Teil führt in das Thema Single-Source- Publishing aus historischer und vor allem aus technologischer Sicht ein. Ebenfalls behandelt werden wesentliche Grundlagen von XML und HTML sowie angrenzende Felder wie CSS. XML-Dokumente lassen sich u. a. in Ausgabeformate wie HTML oder PDF umwandeln. XSLT und XSL-FO sind etablierte Basistechnologien für diese Zwecke. Ihre Anwendung wird im schriftlichen Teil sehr ausführlich und anschaulich dargestellt. Der praktische Teil beschreibt Anforderungen für die produzierten Unterlagen (Bröschüre/Flyer, Montageanleitung und Preisliste für Wärmepumpen) sowie die technische Umsetzung unter Nutzung der genannten Technologien. 133

3 Dittrich, Juliane (Matrikel M-TRW 06, Praxisbetreuerin: Frau Dipl.-Tech.-Red. (FH) B. Horn) Vergleich von Autorenwerkzeugen zur Erstellung von Online-Hilfe und Handbuch für ein browserbasiertes Enterprise Content Management System (2008): Die Autorin hat sich im Rahmen ihrer Masterarbeit mit den Dokumentationsprozessen in der Firma forcont business technology GmbH beschäftigt. Ihre konkrete Aufgabe bestand in der Analyse der gegenwärtigen Umsetzung von Onlinehilfe und Handbuch für ein Softwareprodukt (CM-System). Insbesondere sollte ein Autorenwerkzeug gefunden werden, welches den spezifischen Firmenanforderungen gerecht wird (HTML-Hilfe, Java-Hilfe sowie gedrucktes Handbuch). Im theoretischen Teil werden zunächst die Ziele und Kernanforderungen sowie notwendige technologische Grundlagen wie verwendete Auszeichnungssprachen (HTML/XML) und CSS zur Formatierung und Darstellung der Inhalte beschrieben. Außerdem wird ausführlich auf das Thema Onlinehilfe und konkrete Umsetzungsmöglichkeiten eingegangen. Aus praktischer Sicht wurde das Format JavaHelp und eine browserbasierte Hilfe für das forcont-produkt favorisiert. Am Markt existiert eine Vielzahl an Werkzeugen zur komfortablen Erstellung von Onlinehilfen in unterschiedlichen Formaten sowie gedruckter Handbücher. In einem Vergleichstest hat die Autorin eine Reihe solcher Werkzeuge hinsichtlich Erfüllung gestellter Anforderungen überprüft. Die Testkriterien und die erhaltenen Ergebnisse wurden ausführlich präsentiert und bewertet. Am Ende blieben zwei grundsätzlich geeignete Produkte übrig: Doc-To-Help und RoboHelp, wobei sich diese wiederum nur bedingt für eine performante Generierung von Handbüchern eignen. Tischer, Falk (Matrikel M-TRW 06, Praxisbetreuer: Herr Dipl.-Ing. J. Sapara) Implementierung einer HTML-Ausleitung aus dem Redaktionssystem SCHEMA ST4 zur Weiterverwendung als 134

4 Onlinehilfe (2008): In dieser Arbeit steht die technologische Umsetzung von Onlinehilfen im Mittelpunkt. Der Autor hat das Thema in der Firma SMA Solar Technology AG bearbeitet. Dort wird das kommerzielle Redaktionssystem SCHEMA ST4 zur Erstellung von technischen Dokumentationen eingesetzt. Für dieses System hat der Autor nach Möglichkeiten zur Ausgabe plattformunabhängiger Onlinehilfen gesucht und eine konkrete Anwendung auf der Basis von XSLT implementiert. Nach der einleitenden Darstellung von Motivation und Zielstellung der Arbeit werden im Kapitel Grundlagen die verwendeten Technologien benannt und mit Beispielcode untersetzt. Weitere Ausführungen zu den komplexeren Themengebieten Single-Source-Publishing und Content-Management sowie der praktischen Nutzung des Redaktionssystems schließen sich an. Ausgehend von den im Kapitel Analyse zusammengestellten Aussagen zu den bisherigen HTML-Produktionsmöglichkeiten über das genannte System und den Spezifikationen für Onlinehilfen bei SMA, beschreibt der Autor im Kapitel Technische Realisierung sein Vorgehen zur technischen Umsetzung der HTML-Ausleitung. Dieses Kapitel bildet den Hauptteil der Arbeit und veranschaulicht vor allem die geleistete praktische Entwicklungsarbeit, speziell die Programmierung mit den Technologien XSLT und XPath auf der Ebene der Inhalte sowie mit JavaScript für Navigationszwecke und eine Suchfunktion. IKS Kw/Ww KAT FPT Aw/Ao 2. Veröffentlichte Fachartikel Die nachfolgend aufgelisteten Arbeiten sind im Zeitraum entstanden und überwiegend dem Lehr- und Forschungsthema XML-Technologien zuzuordnen. Spatz in der Hand Abfrage von Twitter-Nachrichten mit XSLT und PHP; Entwickler Magazin , S Himmelsscheibe.svg Ein SVG-basiertes Analyse- und Experimentierwerkzeug; Entwickler Magazin , S. 135

5 (Co-Autorin: Mechthild Meinike). Silberlichtverstärker Einsatz des Downloader-Objekts in Silverlight-Anwendungen; Entwickler Magazin , S Einfach funktional Verwendung benutzerdefinierter Funktionen in XSLT 2.0-Stylesheets; Entwickler Magazin , S Fließbandproduktion Mit DITA und xsl:result-document zur Onlinehilfe; Entwickler Magazin , S Gehaltene Konferenzvorträge Web-Entwicklung mit Microsoft Silverlight Grundlagen und Aktionsprogrammierung. In: tekom, Gesellschaft für technische Kommunikation e. V., Tagungsband zur Jahrestagung 2008 in Wiesbaden, S XSLT 2.0 und XPath 2.0 für Praktiker Neuerungen im Überblick. In: tekom, Gesellschaft für technische Kommunikation e. V., Tagungsband zur Jahrestagung 2007 in Wiesbaden, S Syntax-Highlights von XSLT 2.0 und XPath 2.0, AJAX IN ACTION 2007 in Frankfurt-Mörfelden. Weiteres Material wie PDF-Versionen von Artikeln und Vortragspräsentationen, Codebeispiele sowie Buchrezensionen sind auf der Website des Autors unter verfügbar. 136

6 Dr. Thomas Meinike IKS Lehrkraft für besondere Aufgaben an der Hochschule Merseburg (FH) Kw/Ww Kurzvita absolvierte ein naturwissenschaftliches Studium und ist seit 1997 an der Hochschule Merseburg (FH) als Lehrkraft für besondere Aufgaben tätig. Arbeitsschwerpunkte: XML-Anwendungen in der Technischen Dokumentation Onlinehilfen und Webentwicklung. KAT FPT Aw/Ao 137