Modularisierung. in der Technischen Dokumentation

Transkript

1 Modularisierung in der Technischen Dokumentation Methoden für das Content Management Tekom RG Bodenseeraum 19. Juli 2007 Prof. Dr. W. Ziegler (HsKA)

2 Content Einführung Theorie der Modularisierung Praxis der Modularisierung Aus- und Überblick Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 2

3 Warum Modularisierung? Wiederverwendung! Inhaltskontrolle Strukturkontrolle Prozesskontrolle }QS Output (Menge, Qualität) CM Kosteneffizienz Zeiteffizienz Eingesetzte Ressourcen (Zeit, Geld) Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 3

4 Einsatz von Content Management Systemen ,4% 35,7% tekom ,7% 7,2% 0 Informationsphase Entscheidungsphase Entscheidung gegen CMS Entscheidung für CMS Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 5

5 Redaktionsprozesse im Content Lifecycle Bsp: Danfoss * ** Versionierung, Varianten, *** TMS ** *** Sprachen Retrieval Module Module Dokumente QS klassifizieren erfassen erstellen Publizieren Archiv. ** ** * * *** * *** *** Zielgruppen Medien Dokutypen Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 6

6 Anwendungsszenarien Klassisch-redaktionelle Prozesse Verarbeitung von Produktinformationen Integrative Prozesse Vernetzung von Produktinformationen (Collaboration, PLM, ECM) Prof. Dr. W. Ziegler Studiengang TR 7 Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 7

7 Vision: Teile-Information Wearable Computing & Augmented Reality Arvika: TZI Uni Bremen Teileerkennung (Varianten) Lageerkennung (Messdaten) Informationsdarstellung Kommunikation Ersatzteilbestellung RFID Technologiediskussion Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 9

8 Systemtheorie Zu erfüllende Kriterien: Komplexität Flexibilität Stabilität Organisationsprinzip: Module Protokolle = Austauschschnittstellen Protokolle bestimmen Güte der eingehaltenen Kriterien! Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 10

9 Standardisierung Betroffene Prozesse: Module klassifizieren Module erfassen QS *,** ** ** *** *** Leitfaden + Term- und Textkontrolle Methodik + Klassifikation Methodik + DTD/XSD Editoren + XML Editoren + Unicode Schreibregeln Modularisierungsregeln Informationsmodell Datenformat Zeichenformat Grafik/Medien-Standardisierung analog! Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 11

10 Theorie der Modularisierung Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 13

11 Spektrum der Modulgröße Modulgröße Database Publishing Daten CMS Kapitel Dokument Managing }DB- System PC-DB / Office XML- Module Modulares DTP }Datei- System Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 14

12 Grundlegende Kriterien der Wiederverwendung Abgeschlossenheit redaktionell einfach, eindeutig kontextfrei, in unterschiedlichen Kontexten wieder zu verwenden (Maximale) Wiederverwendbarkeit flexibel, kombinierbar als Ganzes wieder verwendbar Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 15

13 Konsequenzen der Modularisierung Verwaltungsaufwand Komplexität Redundanzen (Geringere Wiederverwendung) Flexibilität Abgeschlossenheit Modulgröße Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 16

14 Größenverteilung von Modulen % tekom CMS- Studie 2005 DOG Daten Sätze Absätze Seiten Komponenten Kapitel Nicht modular Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 17

15 Modulbildung auf allen Ebenen Wiederverwendung kann in allen Größenordungen sinnvoll sein: Dokument Kapitel Sinneinheit (Topic / Funktionale Einheit) Satz Wort Daten Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 19

16 Content-Varianten Variantenproblematik Praxisbeispiel: Betriebsanleitung für Radlader Bedienung von unterschiedlichen Fahrersitzvarianten (bedien_2.pdf) Welche Modulgrößen sind sinnvoll? Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 20

17 Content-Varianten Grundproblem der Redundanz bleibt bei Modulbildung potenziell auf allen Ebenen erhalten! 1 Reuse? wenig Redundanz viel Redundanz Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 21

18 Redundanz (innerhalb Unterkapitel / Komponenten-Modul) Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 22

19 Redundanz (innerhalb Topic) Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 23

20 Redundanz (innerhalb Absatz / Funktionaler Einheit) Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 24

21 Redundanz (innerhalb Satz / Funktionaler Einheit). Die Neigung der Rückenlehne wird mit dem Hebel 1 an der rechten Seite des Sitzes eingestellt... Die Neigung der Rückenlehne wird mit dem Hebel 2 an der linken Seite des Sitzes eingestellt.. Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 25

22 Methoden für Content-Varianten Vererbung *** Reuse Pool * Variantensammlung *** Lebende Kopie * Fragmentierter Reuse ** W. Ziegler, Fünf Methoden für die Feinarbeit technische kommunikation 3/2005 Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 26

23 Content-Varianten: Vererbung Reuse Klasse Modul Automatischer Reuse durch Vererbung von Klasseninformationen. Ergänzung von weiteren Informationen. Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 27

24 Content-Varianten: Reuse-Pool Reuse? Reuse-Pool Modul Manuelle Auswahl und Reuse einzelner Elemente aus dem Reuse-Pool. Ergänzungen von weiteren Informationen möglich. Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 28

25 Content-Varianten: Variantensammlung (A) (A,B) (B) (A,B) (A,B) Typ Pos Richtung (A) A B 1 2 rechts links Variantensammlung Gültigkeiten der Elemente für zwei Typen oder Zielgruppen A und B. Auswertung erfolgt bei der Publikation. Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 29

26 Zusammenfassung der Theorie (Abgeschlossen) Primäre Modularisierung Sekundäre Modularisierung (Content-Varianten) (Flexibel) Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 30

27 Praxis der Modularisierung Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 31

28 Vorgehensweisen Bottom-Up-Analyse vs. Top-Down-Methoden! Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 32

29 Bottom-Up-Analyse I Modulidentifikation durch Dokumentenvergleich Standard Option!! Variante Content-Variante! Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 33

30 Bottom-Up-Analyse I : Dokument-Matrix vgl. Rockley 2003 Content Audit Dokumentstruktur Kap. 1 Dok 1 Mod 1 (S) Dok 2 Mod 1 (S) Dok 3 Mod 1 (S) Kap. 2 Mod 2 Mod 2 Mod 3 (V) (V) (V) Kap. 3 Mod 4 (O) Dok.,Medien, Zielgruppen Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 34

31 Kriterien bei der Analyse Hohe Wiederverwendbarkeit Informationen sollen möglichst von allem befreit werden, was ihre Wiederverwendbarkeit beeinträchtigt: geringfügige Textunterschiede nicht-kompatible Formatierungsmerkmale nicht-passende Bausteingröße Die Wiederverwendbarkeitsrate aller untersuchten Dokumente beträgt im Schnitt 54%. Große Änderungshäufigkeit Die regelmäßige Änderung vorhandener Dokumentationen: Von den 135 Dokumentationsarten, die von den untersuchten Firmen angegeben wurden, werden 117 (87%) regelmäßig aktualisiert. DOG GmbH Dokumentationsmanagement in der Praxis, (2000) Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 35

32 Konsequenzen der Modularisierung Modulvarianten entsprechen nicht immer den Produktvarianten Option ist eine einwertige Variante Es existieren Varianten von optionalen Modulen Die Unterscheidung zwischen optionalem und variablem Modul hängt an der Modulgröße! Matrixdarstellung ist (nur) der Verwendungsnachweis von Modulen, keine eindeutige Modellierungsvorgabe!!!! Ablage+Kennzeichnung Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 36

33 Bottom-Up-Modularisierung II (Software-Doku.) Analyse und Modulbildung nach Ament First, single sourcing ist a methodology, not a technology. Although single sourcing can involve very complex technologies, modular writing is what drives the process. Second, modular documentation is not possible without standardization. Writing standards that are `nice to have` in linear documentation become `must have` in single sourcing. To develop modular content you need writing guidelines that answer usability and re-usability questions directly. Ament (2003), Single Sourcing - Building Modular Documentation Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 37

34 Bottom-Up-Modularisierung II 10-stufige Methodik nach Ament (2003) 1. Module identifizieren 2. Module benennen 3. Module organisieren 4. Module erfassen 5. Module editieren 6. Dokumente aufbauen 7. Verweise erstellen 8. Dokumente konvertieren 9. Dokumente testen 10. Leitfaden entwickeln (Text in Module aufteilen) (Modultitel vergeben) (Untermodule integrieren, Hauptmodule ablegen) (Texte schreiben, formatieren) (Mediales und QS-Lektorat) (Module zusammenbauen) (IHVZ, Glossar, Links) (Verschiedene Formate) (Usabilitytest der Texte) (Regeln aus 1-9 ableiten) SSP/Ament_SS_chapter2_2003.pdf Ament (2003), Single Sourcing - Building Modular Documentation Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 38

35 Bottom-Up-Modularisierung II Module identifizieren: Ament (2003) Primäre Module Einteilung nach Modultypen entsprechend der (Unter-) Kapitel Sekundäre Module Extraktion nach funktionalen Aspekten Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 39

36 Top-Down-Modularisierung I: VDW 3-stufige Modularisierungsmethodik (für Betriebsanleitungen / Maschinen- und Anlagenbau) 1. Grundstruktur Kapitel der Anleitung nach rechtlichen Vorgaben und Produktlebenszyklus gliedern VDW\Kurzinformationen spez T1.pdf, tekom Leitfaden Betriebsanleitungen 2. Feinstruktur Module in Dokumentenmatrix einordnen Matrix wird aufgespannt aus Dokument- und Produktstruktur 3. Modulstruktur Schreib- und Formatierungsregeln standardisieren VDW\Kurzinformationen spez T2.pdf Style Guide als Ergebnis der VDW-Studie (Zu 1. und 3.): VDW\Style Guide.pdf Pfeifer, Lorenzi, Schmidt, Betriebsanleitungen modular aufbauen, technische komunikation 2/2002, S. 19 Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 40

37 Dokumentenmatrix Produktstruktur vs. Dok.struktur Voraussetzung für automatisierte (stücklistengetriebene) Dokumentgenerierung Basis für klassifizierende Metadaten (Gültigkeiten) Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 41

38 Umsetzung im Informationsmodell DOCU (Semantische) Auszeichnung der Informationen/Tätigkeiten im Produktlebenszyklus Funktionale Informationsmodellierung Konzept seit 1997 bei LIEBHERR im Einsatz Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 42

39 Top-Down-Modularisierung II Modularisierung gemäß standardisierten Informationsmodellen und -prozessen Docbook S1000D DITA mumasy. Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 44

40 S1000D ASD/AIA (Luftfahrt/Militär) Data Modules (DM): Procedure Descriptive Parts Data. Data Module Code (DMC) und Informationsmodell (s.57 ff) Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 45

41 Top-Down-Modularisierung III Modularisierung in Abhängigkeit von sprach-zentrierten Theorien/Methoden Funktionsdesign (Sprechakt-Theorie) Sprachlich-Funktionale Einheiten und Sequenzmuster Information-Mapping (Kognitions-Psychologie) Wahrnehmungsoptimierte Informationsgrößen und -strukturen Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 47

42 Parameter der Modularisierung Die Größe ergibt sich aus den angewandten Kriterien und Ziele der (top-down und/oder bottom-up) Methoden bzw. Vorgaben: Abgeschlossenheit vs. Wiederverwendungshäufigkeit Content-Varianten Informationsmanagement (entlang Produktlebenszyklus) Informationsmodellierung (FD, IMAP, Topic,.) Automatisierung/Kopplung an ERP Sonderfälle, u.a. Seitenorientierung Fremddokumentation Daten- /Satzweise Wiederverwendung aus DB Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 48

43 Produktstruktur Regelbasierung Wiederverwendungshäufigkeit Redaktions-/Infoman.- Konzept System-Funktionalität Modularisierung Informationsmodell Content-Varianten Dokumentstruktur Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 49

44 Ausblick / Überblick Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 50

45 Einführung von Content Management Systemen Vorgehensmodell in 10 Schritten: Analyse des IST-Zustandes 2. Darstellung des Optimierungspotenzials 3. Definition der SOLL-Zustandes 4. Evaluierung der Systeme und Auswahl 5. Erstellung eines Pflichtenheftes 6. Interne Vorbereitung 7. Systemanpassung 8. Installation des Systems 9. Schulungsmaßnahmen 10. Systemnutzung Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 51

46 6. Interne Vorbereitung (spätester Zeitpunkt, teilweise bereits ab 3.) Festlegung der Informations-Standardisierung Strukturelle oder funktionale Standardisierungsmethoden Informationsmodelle und Datenformat Terminologie und Formulierungsrichtlinien Modularisierungskonzept Variantenkonzept (Produkt- und Content-Varianten) Meta-Informationen (Grafikkonzept, Kennzeichnung von Modulen) für Ablage und Suche Publikationskonzept (Styles, Medien) Altdatenkonvertierung/Umstiegsszenario Organisatorische und technische Rahmenbedingungen Proof-of-concept und/oder Nutzen eines Testsystems, evtl. Detailänderungen der Funktionalitäten 17 Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 52

47 Entwicklung eines Modulkonzeptes Kriterien Aufgabe Ergebnis Wiederholung Änderungshäufigkeit Dok.analyse Dok.matrix (Dok.struktur Produkte) Produktstruktur (ERP) Dok.redundanzen Moduldefinition Dok.matrix. Dok.vorlagen (Prod.struktur Dok.Struktur) Produktart Info.arten Dokumenttypen Info.modellierung DTD, XSD, DOT, Schreib-/Strukturierungsrichtlinien Produktvarianten Mod.redundanzen Variantenanalyse Mod-Varianten Unter-Module (Reuse-Pool), Variablen, Parameter Automatisierung Metadatendefinition Klassifikation Ablagestruktur, Metadaten (Gültigkeiten) Prof. Dr. W. Ziegler - Grundlagen der Modularisierung 55