Der Dokumentationsalltag mit einem XML-basierten Redaktionssystem

Transkript

1 Der Dokumentationsalltag mit einem XML-basierten Redaktionssystem München, 22. Oktober 2009 Maria Heinrich, Technische Redakteurin

2 Das Arbeitsgebiet Dokumentation rund um die Chipkarte Betriebssysteme Kartenapplikationen Simulationstools Testtools Personalisierungsverfahren usw. Zielgruppe Chipkarten-Entwickler 22. Oktober 2009 Folie 2

3 Seit fünf Jahren.. XML DTD Struktur + Information Mapping Funktionsdesign + Datenbank Versionierung Bearbeitungsstatus + TCToolbox FrameMaker XMetal + PDF CHM Eclipse Help = XML-basiertes Redaktionssystem 22. Oktober 2009 Folie 3

4 Entstanden in 5 Jahren Maps Grafiken + 40% Wiederverwendung bei Maps + 25% Wiederverwendung bei Grafiken = erstellte Seiten = 180 Handbücher und Onlinehilfen 22. Oktober 2009 Folie 4

5 Das Dokumentationsteam Das Team Technische RedakteurIn (DE) Technische RedakteurIn (DE) Übersetzer/Technischer Redakteur (EN) Übersetzer/Technischer Redakteur (EN) Beteiligt an Entscheidungen Ermutigt durch Zwischenergebnisse Gefordert durch die Umsetzung 22. Oktober 2009 Folie 5

6 Die Ziele Wunsch und Wirklichkeit Wir wollten... Granulierte und wiederverwendbare Informationseinheiten Konsistente Strukturen Automatisierte Produktion aus einer Quelle Plattformunabhängige Speicherung Datenaustausch mit Entwicklern Datenaustausch mit ext. Redakteuren Wir haben Maps, Variable, Masterlisten, Varianten Ja, dank DTD und XML-Template Ja XML-Dateien + DTD Ja mit XML Ja mit XML und FrameMaker Die Quintessenz Dauerbrenner Wiederverwendung Dauerbrenner Arbeitsabläufe, Vorgehensweisen Man könnte doch 22. Oktober 2009 Folie 6

7 Der Kulturschock XML Der Anfang XML ist sperrig Kulturschock für DTPler Jeder will XML aber keiner will damit arbeiten... XML ist kompatibel Freie Auswahl bei XML-Editoren Und Heute? Einfach Bequem Geregelt XML + DTD XML-Editor mit Komfort Kulturschock erlebt jeder Die Quintessenz Struktur steht im Vordergrund Die Arbeitsumgebung alles im Blick Layout ist (manchmal) Ballast Freie Auswahl oder optimierter Komfort 22. Oktober 2009 Folie 7

8 Das Korsett DTD Die Entscheidung Maßgeschneiderte DTD Information Mapping Funktionsdesign Semantik Namenskonventionen Und Heute? Passt! Hohe Akzeptanz Denken in Strukturen Mitwachsen notwendig Die Quintessenz DTD ist das Fundament und Herzstück Aufwand ist gut investiert Strukturierungsmethode(n) sind unverzichtbar Maßgeschneidert bedeutet Folgekosten 22. Oktober 2009 Folie 8

9 Das Zentrum Datenbank Die Entscheidung Vorgabe Oracle Map als Informationseinheit Grafikverwaltung Rollen und Rechte Und Heute? Alles an einem Ort Abfragemöglichkeiten Reports Server ist in IT-Hand Die Quintessenz Nachvollziehbarkeit Erfordert neues Denken Grundlage für die Wiederverwendung Absprachen mit sind IT wichtig 22. Oktober 2009 Folie 9

10 Das Lockmittel Wiederverwendung Die Anfänge Granulation auf Map-Ebene Single Source Publishing Definierte Textteile Stringvariable Elementvariable Variantenmanagement Produktübergreifend } } Und Heute? Funktioniert einwandfrei Einfach zu handhaben Einsparpotential Noch ausbaufähig Der Teufel steckt im Detail Dringt in alle Arbeitsweisen und Funktionen Die Quintessenz Wiederverwendbare Textteile identifizieren Durchdachte Strukturierung ist das A und O Das Was und Wie bestimmen die Funktion im Tool Arbeitsweise Einigkeit macht stark 22. Oktober 2009 Folie 10

11 Stellenwert beim Management Der Anfang Idee und Konzept der Dokumentation Umsetzung durch Dokumentation Finanziert durch Bereichs-Budget Wenige Vorgaben Verpflichtung zum betriebwirtschaftlichen Nutzen Das Ansehen 2009 Mit Argusaugen betrachtet Kosten für die Pflege Frage nach Kosten-Nutzen System überdimensioniert? Stellenwert der Folgekosten bei Word? Suche nach Alternativen zu Word Die Quintessenz XML aus der Word-Perspektive - Zwei Welten Was wird als Nutzen anerkannt? Maintenance - Abwägen von Nutzen und Aufwand Wiederverwendung - Silbersteifen am Horizont Nutzen schwer zu beweisen 22. Oktober 2009 Folie 11

12 Die gefühlte Kosten-Nutzen-Rechnung Aufwand durch Intensive Strukturierung Pflege Redaktionssystem Aufbau Know-how Einsparung durch Definierte Strukturen Automatisiertes Layout 1 Editierumgebung Datenbankfunktionalität Wiederverwendung 22. Oktober 2009 Folie 12

13 Kostenverteilung Rahmenbedingungen 5 Redakteure/Innen Oracle als DB Aufbau Know-how Eigene DTD Implementierung/Anpassungen 15% Tools/Lizensen Schulung 25% 60% 22. Oktober 2009 Folie 13

14 Die neuen Herausforderungen IT-Projekt Planung Pflege Bugs Prozesse Review - Freigabe Varianten Werben für XML 22. Oktober 2009 Folie 14

15 Erfahrungen aus dem Dokumentationsalltag Wichtig und hilfreich XML-Template Masterdateien Namenskonventionen Das Element ToDo Datenbankabfragen Grafikverwaltung Publikation verschiedener Medien Arbeiten im Kontext. Achtung! Erweiterungen sind langwierig Erweiterungen sind teuer Dran-Denk-Lösungen Abhängigkeit vom Hersteller Arbeitsabläufe sollen den Automatismus bestimmen 22. Oktober 2009 Folie 15

16 Kontakt Noch Fragen? Maria Heinrich Giesecke & Devrient GmbH Prinzregentenstraße 159 D München Tel Oktober 2009 Folie 16

17 Danke für Ihre Aufmerksamkeit 22. Oktober 2009 Folie 17