Strukturierungsmethoden im Überblick

Transkript

1 Martin Holzmann

2 Themenüberblick Standardisierungsmethoden vs. Standards Funktionsdesign und mumasy Information Mapping und DITA Weitere Standards DocBook ASD S1000D ATA ispec 2200 SPL 2

3 Standardisierungsmethoden vs. Standards Standardisierungsmethoden sind Ansätze, mit denen der individuelle Bedarf an Dokumentstrukturen ermittelt werden kann. Daraus ergibt sich ein individuelle DTD. Bekannte Standardisierungsmethoden: Funktionsdesign Information Mapping 3

4 Standardisierungsmethoden vs. Standards Standards sind DTDs, die für eine bestimmte Anwendung oder Branche entwickelt wurden. Universelle Standards DITA DocBook Branchenspezifische Standards mumasy (zukünftig VDMA Einheitsblatt 66320) AECMA/ASD S1000D ATAiSpec 2200 SPL 4

5 Universelle Standards Ziel Eierlegende Wollmilchsau Wie kann man das Ziel erreichen? Möglichkeit 1: Eine DTD, in der alles drin ist, was man irgendwann mal gebrauchen könnte DocBook Möglichkeit 2: Eine Basis-DTD, die leicht entsprechend klar spezifizierter Regeln angepasst werden kann DITA 5

6 Branchenspezifische Standards Ziel Für eine Branche sollen die folgende Aspekte gewährleistet werden: Austauschbarkeit Kombinierbarkeit Anwenderorientierung Probleme Mehrere Standards für eine Industrie SPL (Structured Product Labeling von der FDA) PIM (Product Information Management von der EMA) Teilweise sehr komplex ASD S1000D hat z. B. mehr als 2000 Seiten 6

7 Themenüberblick Standardisierungsmethoden vs. Standards Funktionsdesign und mumasy Information Mapping und DITA Weitere Standards DocBook ASD S1000D ATA ispec 2200 SPL 7

8 Funktionsdesign Basis: Sprechakttheorie Jeder Text hat ein kommunikatives Handlungsziel Für jede Art von Handlungsziel gibt es optimale Formulierungsmuster Konsequenz Alle Teile eines Handbuchs müssen eindeutig als Funktionale Einheit identifiziert werden Für jede Einheit gibt es Regeln und Muster 8

9 Funktionsdesign Elemente des Funktionsdesigns Informationsprodukte Zielgruppenorientierte und produktbezogene Dokumentarten, z. B. Bedienungsanleitung, Installationsanleitung Sequenzmuster Typische Abfolge Funktionaler Einheiten z. B. Baugruppenbeschreibungen, Warnhinweise Funktionale Einheiten Bilden den eigentlichen Inhalt der Dokumente ab z. B. Handlungsaufforderung, Zielangabe Auszeichnungselemente Dienen der Auszeichnung von Bedeutungselementen innerhalb von Funktionalen Einheiten z. B. Kommando, Dialogfeld 9

10 Funktionsdesign Klare Definition aller Elemente Informationsprodukte Für welche Zielgruppe? Wann wird das Dokument benötigt? Medium Struktur Sequenzmuster Wofür verwenden? Wofür nicht? Sequenzierung Struktur Layout 10

11 Funktionsdesign Klare Definition aller Elemente Funktionale Einheiten Wofür verwenden? Wofür nicht? In welchen Sequenzmustern verwenden? Struktur/ Formulierung Gestaltung Auszeichnungselemente Wofür verwenden? Wofür nicht? Formulierungsregeln Auszeichnung 11

12 Funktionsdesign Vorteile der Methode Flexibel in der Anwendung, da Funktionsdesign immer für eine bestimmte Umgebung definiert wird. Liefert vollständigen Redaktionsleitfaden und DTD in einem Schritt. Kontrolliert nicht nur die Struktur, sondern macht auch klare Vorgaben für die Sprache. Reduziert Übersetzungskosten 12

13 mumasy (VDMA Einheitsblatt 66320) mumasy Ursprung: Forschungsprojekt Multimediales Maschineninformationssystem wurde unter der Koordination des VDMA (Verband der Deutschen Maschinen- und Anlagenbauer) erstellt Ziel: Informationsaustausch zwischen Zulieferern, Herstellern und Kunden von Maschinen Resultat: interessanter, aber akademischer Ansatz Nächster Schritt: In eine anwendbare Form bringen Resultat: VDMA Einheitsblatt steht kurz vor seiner Veröffentlichung Strukturelle Basis: Funktionsdesign 13

14 mumasy (VDMA Einheitsblatt 66320) Spannend: die Beziehungen der Elemente 14

15 mumasy (VDMA Einheitsblatt 66320) Die Zukunft? Das Einheitsblatt ist ein Anfang. Ein Referenzhandbuch ist in Arbeit. Viele Hersteller sagen, sie sind bereit. Aber echte Umsetzungen sind noch nicht in Sicht. Was sagen Sie? 15

16 Themenüberblick Standardisierungsmethoden vs. Standards Funktionsdesign und mumasy Information Mapping und DITA Weitere Standards ASD S1000D ATA ispec

17 Information Mapping Basis Erkenntnisse aus der kognitiven Psychologie Wie nimmt der Mensch Informationen auf und wie verarbeitet er sie? Resultate Die Informationen müssen in Einheiten untergliedert werden, die die kognitiven Fähigkeiten des Menschen nicht überfordern. Anwender haben bestimmte Fragen an ein Dokument. Dies Fragen lassen sich kategorisieren. Für jede Fragekategorie gibt es Antwortmuster, die leicht verständlich sind. 17

18 Information Mapping Einführung neuer Informationseinheiten Block Map Map - nur Blöcke, die relevant sind! Blocktitel Blocktitel Blockinhalt, immer ein abgegrenztes Thema! Liste... Blockinhalt, immer ein abgegrenztes Thema! Liste... 18

19 Information Mapping Information Mapping definiert 7 Prinzipien, die bei der Strukturierung der Informationen helfen Gliederungsprinzip: Informationen in übersichtliche/leicht zu verarbeitende Einheiten gliedern. Relevanzprinzip: Nur thematisch zusammengehörige und für den Leser wesentliche Informationen. Betitelungsprinzip: Jede Einheit mit einem Titel versehen, der Zweck, Funktion oder Inhalt bezeichnet. Einheitlichkeitsprinzip: Ähnliche Informationen, Gliederungen oder Formate einheitlich behandeln. Fortsetzung auf nächster Seite 19

20 Information Mapping Information Mapping definiert 7 Prinzipien, die bei der Strukturierung der Informationen helfen, Fortsetzung Prinzip der Gleichwertigkeit der Informationsträger: Diagramme, Bilder, Tabellen und Text müssen sich gegenseitig ergänzen. Prinzip der Verfügbarkeit von Einzelheiten: Einzelheiten dem Leser an der Stelle zur Verfügung stellen, wo er sie braucht. Prinzip der systematischen Gliederung und Betitelung: Gliederung und Betitelung systematisch auf alle Hierarchieebenen anwenden. 20

21 Information Mapping Die 7 Informationsarten nach Information Mapping sind: Prozeduren: Wie gehe ich vor? Prozesse: Wie funktioniert das? Strukturen: Wie sieht es aus? Wie ist es aufgebaut? Begriffe: Was ist es? Prinzipien: Was muss ich tun? Was muss ich beachten? Fakten: Was sind die Daten? Klassifikationen: Welche Arten gibt es? 21

22 Information Mapping Vorteile der Methode Die Informationseinheiten Map und Block stellen in vielen Fällen die optimalen Korngrößen für die Verwaltung in einem Redaktionssystem dar. Map und Block funktionieren sowohl für Papier als auch für Online-Formate. Eine Map entspricht einem Topic. Erprobte Antwortmuster sorgen für leicht verständliche Dokumente. International verfügbare Schulungen erleichtert die Verwendung in internationalen Unternehmen. 22

23 DITA Darwin Information Typing Architecture Grundkonzepte von DITA Ursprung: IBM internes Projekt Inzwischen: Ein OASIS Standard Ziel: Wiederverwendung von Informationen ermöglichen Basis: eine DTD, die nach festen Regeln verändert werden kann (spezialisiert) So genannte Domains erlauben die Ergänzung des DITA Vokabulars um branchenspezifische Elemente Fortsetzung auf nächster Seite 23

24 DITA Darwin Information Typing Architecture Grundkonzepte von DITA, Fortsetzung Topic-orientiertes Schreiben keine vorgegebene Buchstruktur Topics sind frei kombinierbare, wiederverwendbare Objekte Jeder Topic gehört zu einem bestimmten Informationstyp allgemeiner Topic Concept-Topics (Begriffserklärung) Task-Topics (Anleitung) Reference-Topics (Nachschlageinformation) Fortsetzung auf nächster Seite 24

25 DITA Darwin Information Typing Architecture Grundkonzepte von DITA, Fortsetzung Hierarchien entstehen durch Topics, die andere Topics referenzieren (wenn s denn sein muss!) Maps, die quasi die Stückliste einer Publikation darstellen Maps können auch Linkinformationen für Links zwischen verschieden Topics enthalten! die Topics könne also ohne Linkinformationen geschrieben werden Topics werden damit problemlos wiederverwendbar 25

26 DITA Darwin Information Typing Architecture Die Zukunft (hat schon begonnen) DITA Unterstützung durch praktisch alle namhaften Editorhersteller Für alle Medien frei verfügbare Publikationsprozesse Mehrere Projekte schon realisiert IBM Adobe Nokia 26

27 Themenüberblick Standardisierungsmethoden vs. Standards Funktionsdesign und mumasy Information Mapping und DITA Weitere Standards DocBook ASD S1000D ATA ispec 2200 SPL 27

28 DocBook 1991 gestartetes Projekt von HaL Computer Systems and O'Reilly Ziel: Dokumentation von UNIX Enthält ein sehr umfangreiches Set an Elementen Alles kann mit DokBook dokumentiert werden Keine Führung für den Redakteur Wird meistens zurechtgestutzt Sehr umfangreiche Unterstützung Für viele XML-Editoren frei verfügbar Für alle Medien frei verfügbare Publikationsprozesse 28

29 ASD S1000D ASD = AeroSpace and Defence Industries Association of Europe (früher AECMA) verpflichtend im Bereich Militär regelt nicht nur die inhaltliche Struktur der Dokumente, sondern definiert den Erstellungsprozess und Regeln für den Datenaustausch die Modularisierung (so genannte Data modules) die Verwaltung der Module in welchen Formaten Zeichnungen zu erstellen sind wie Zeichnungen zu gestalten sind Regeln für die sprachliche Ausformulierung der Dokumente (AECMA Simplified English) Der Standard (3.9.2 Seite 19) 29

30 Weitere Standards ATA = Air Transport Association of America ATA ispec 2200: Information Standards for Aviation Maintenance Aircraft Maintanance Manual Aircraft Recovery Manual Structural Repair Manual Flight Crew Operations Manual Wiring Manual SPL Standard Product Labeling Ist ein Standard für die Pharmazeutische Industrie, der zukünftig eine Vorgabe der FDA sein wird 30

31 Noch Fragen??