XML in der Praxis: Technische Dokumentation

Transkript

1 XML in der Praxis: Technische Dokumentation Ulrike Schäfer INFOTAKT information design tekom Berlin Brandenburg Regionaltreffen Ulrike Schäfer. Folie 1

2 Übersicht Problemstellung Wie funktioniert XML? XML für den Datenaustausch XML für Dokumentation und Publishing Empfehlungen Ulrike Schäfer. Folie 2

3 Problemstellung Ulrike Schäfer. Folie 3

4 Ein typisches Szenario Technische Dokumentation z.b. Datenblätter, Kataloge, Betriebsanleitungen,... Datenaustausch von / zu Lieferanten, Partnerfirmen etc. Publikation Druck CD ROM Web... Ulrike Schäfer. Folie 4

5 Klassische Probleme Mehrfach- Erfassung, WYSIWYG Technische Dokumentation z.b. Datenblätter, Kataloge, Betriebsanleitungen,... Publikation Datenaustausch von / zu Lieferanten, Partnerfirmen etc. Je nach Partnerfirma unterschiedlich. Manueller Aufwand Druck CD ROM Web... Ulrike Schäfer. Folie 5 Manueller Aufwand pro Medium / pro Publikationsformat

6 Strukturierte Datenhaltung Single Source XML-Einsatz Technische Dokumentation z.b. Datenblätter, Kataloge, Betriebsanleitungen,... Datenaustausch von / zu Lieferanten, Partnerfirmen etc. Publikation Druck CD ROM Web... Ulrike Schäfer. Folie 6 XML als Austauschformat Automatisierung (XSL u.a.) Multiple Use

7 Wie funktioniert XML? Ulrike Schäfer. Folie 7

8 Beispiel: Bedienungsanleitung Ulrike Schäfer. Folie 8

9 Sicherheitshinweis (Teil einer Bedienungsanleitung) Ulrike Schäfer. Folie 9

10 Sicherheitshinweis Warnung Titel Liste Maximale Umgebungstemperatur Ulrike Schäfer. Folie 10

11 Das Dokument in XML- Struktur (Ausschnitt)... XML macht Inhalte maschinenlesbar Ulrike Schäfer. Folie 11

12 Regeln Beispiel Dokumentkopf: q Produktname q Produkttyp q Bestellnummer Mit XML lassen sich Regeln formulieren DTD: Document Type Definition Ulrike Schäfer. Folie 12

13 Anwendungsbeispiel Die DTD für Bedienungsanleitungen... Erfassung in einem XML-Editor... Ulrike Schäfer. Folie 13

14 Layout und Verarbeitung Style Sheet für die Bildschirmdarstellung Transformation q PDF für den Druck q HTML fürs Web q HTML 2 für die CD ROM q... Ulrike Schäfer. Folie 14

15 Fazit XML sagt nichts über Layout, sondern über Inhalte q => macht die Inhalte maschinenlesbar XML formuliert Regeln q => macht Regeln automatisch überprüfbar Voraussetzung dafür, q dass die Publikation automatisierbar wird q dass der Datenaustausch automatisierbar wird Ulrike Schäfer. Folie 15

16 XML für den Datenaustausch Ulrike Schäfer. Folie 16

17 Datenaustausch Technische Dokumentation z.b. Kataloge, Preislisten,... Datenaustausch von / zu Lieferanten, Partnerfirmen etc. Strukturierte Daten (z.b. relationale Datenbank) XML als Austauschformat Ulrike Schäfer. Folie 17

18 Beispiel: Produktkatalog Händler Kunde Produkthersteller Produktkategorien, Produkteigenschaften Produktauswahl, Individuelle Preise Bestellung Ulrike Schäfer. Folie 18 XML-Standard z.b. BMEcat

19 Szenario Datenerfassung und speicherung in Datenbank-Applikationen Export und Transformation nach XML für die Lieferung Import und Verwendung in Datenbank-Applikationen Ulrike Schäfer. Folie 19

20 Am Beispiel Produktkataloge Erfassung und Speicherung in einer Access-Datenbank... Der XML-Standard BMEcat: Eine Branchen-DTD... Transformation nach XML für die Lieferung... Ulrike Schäfer. Folie 20

21 Fazit Automatisierung des Datenaustauschs Verwendung von Standards = Branchen-DTDs Immer mehr Applikationen unterstützen den Import/Export in diese Standards Geringer Aufwand, wenn Daten strukturiert vorliegen (Datenbanken!) Ulrike Schäfer. Folie 21

22 XML für Dokumentation und Publishing Ulrike Schäfer. Folie 22

23 Dokumentation und Publishing Technische Dokumentation z.b. Datenblätter, Kataloge, Betriebsanleitungen,... Publikation Druck CD ROM Web... Ulrike Schäfer. Folie 23

24 Beispiele Produktdokumentation q Anleitungen (Bedienungsanleitung, Montageanleitung etc.) Verkaufsdokumentation q Datenblätter Ulrike Schäfer. Folie 24

25 Eigenschaften der Daten (1) Bedienungsanleitungen haben eine ganz bestimmte Struktur und Semantik q Kapitel mit Überschriften, Absätzen, Listen, Tabellen q Anleitungen mit Arbeitsschritten q Technische Werte Ulrike Schäfer. Folie 25

26 Publikationen Medien und Formate q Druck q CD ROM q Web Zielgruppen Ulrike Schäfer. Folie 26

27 Wie wird XML eingesetzt? Erfassung in XML q Qualitätskontrolle durch die Regeln der DTD q Nicht das Layout wird festgelegt, sondern die Inhalte: <sicherheitshinweis>, <liste>, <umgebungstemperatur> Transformationsprogramme für die Erzeugung der Publikationen möglichst weitgehend automatisiert! Ulrike Schäfer. Folie 27

28 Erfassung in XML... Ulrike Schäfer. Folie 28

29 Dokumentation und Publishing Technische Dokumentation z.b. Datenblätter, Kataloge, Betriebsanleitungen,... Strukturierte Datenhaltung: XML und Datenbanken Single Source Publikation Druck CD ROM Web... Ulrike Schäfer. Folie 29 Automatisierung (XSL u.a.) Multiple Use

30 Eigenschaften der Daten (2) Der Text enthält technische Daten Einige Produkte sind gleich oder ähnlich beschrieben Einige Textteile sind für ganze Produktgruppen gleich Ulrike Schäfer. Folie 30

31 Technische Daten Das Produkt hat bestimmte Eigenschaften Es gibt Produkthierarchien Diese Informationen werden meist in Datenbanken gehalten In den Dokumenten werden technische Daten verwendet Ulrike Schäfer. Folie 31

32 Verbindung der Welten Dokumente Bedienungsanleitung Datenblatt... Datenbank Produktdaten Produkthierarchie Ulrike Schäfer. Folie 32

33 Ein Beispiel madr = Mindestanlagendruck Ulrike Schäfer. Folie 33

34 Die Erstellung Dokumentation für Vitola 100 DB Option im Editor Produktdaten für Vitola 100 Ulrike Schäfer. Folie 34

35 Gleiche Textmodule Die Fertigstellungsanzeige gilt für eine ganze Produktgruppe: Ulrike Schäfer. Folie 35

36 Die Erstellung Dokumentation für Vitola 100 Automatismus DB Ulrike Schäfer. Folie 36 Modul Fertigstellungsanzeige, gültig für alle Vitola

37 Wiederverwendete Bilder Die Illustration wird in allen Anleitungsarten verwendet (Bedienungs-, Service-, Montageanleitung) Ulrike Schäfer. Folie 37

38 Dokumente und Informationsmodule Textmodule Dokumente Bedienungsanleitung Datenblatt... Illustrationen Produktdaten Ulrike Schäfer. Folie 38

39 Fazit Ausbaustufe 1 q Dokumente werden in XML erfasst qmedienneutral qmit DTD als Kontrollmechanismus q Ermöglicht die automatische Transformation in die Publikationen Ausbaustufe 2 q Wiederverwendung durch Modularisierung: XML und Datenbanken q Erfordert komplexere Konzepte für die Datenhaltung und -erfassung Ulrike Schäfer. Folie 39

40 Empfehlungen Ulrike Schäfer. Folie 40

41 Schritt 1: Ist-Situation prüfen Welche Anforderungen bestehen heute / in Zukunft? q Publikation qneue Medien qzielgruppenspezifische Publikation q Lieferung an Partner Wo entstehen welche Aufwände? q Offensichtliche Aufwände, z.b. qmehrfach-erfassung qmanuelle Eingriffe bei der Publikation qgroßer Aufwand beim Layouten q Versteckte Aufwände, z.b. qsuche nach Informationen qkommunikationsaufwand zwischen Abteilungen Ulrike Schäfer. Folie 41

42 Schritt 2: Konzepte Welche Strategien sind sinnvoll? q Einführung von Standards beim Datenaustausch q Strukturierte Datenhaltung (Produktdaten): Datenmodell q Strukturierte Dokumentation (Texte): DTDs Lösungsalternativen q Minimallösung - Maximallösung Ulrike Schäfer. Folie 42

43 Migration viele Wege führen nach vorne Alternativen prüfen! q Neuerfassung eine gute Lösung bei beschränkter Menge / zu komplexen Strukturen! q Automatische / Teilautomatische Übernahme q KEINE Migration: Nur Neues wird neu strukturiert. Oft eine echte Option! q Schrittweise Übernahme: Altes nur bei Änderung q Von allem etwas je nach Dokumentart und -wert Ulrike Schäfer. Folie 43

44 Schritt 3: Entscheidung Kosten-Nutzen-Schätzung Gewichtung Entscheidung q Nicht: XML ja/nein, sondern: Strukturierte Datenhaltung ja/nein? Phasenplan Ulrike Schäfer. Folie 44

45 Projektdurchführung Arbeitsteilung extern / intern q XML ist keine Programmiersprache! q Externe Unterstützung v.a. bei Konzeption und Einstieg. Datenmodelle, DTDs, Systemarchitektur q Wichtig ist die Brücke zwischen fachlichem und technischem Know How! Keine zu frühe Produktentscheidung Bei größeren Projekten: Prototypen! Ulrike Schäfer. Folie 45

46 Diskussion willkommen! Ulrike Schäfer. Folie 46

47 Danke! Ulrike Schäfer. Folie 47