PI- und die Doku wird rund

Transkript

1 π PI- und die Doku wird rund Was bringt das PI-Konzept für die Praxis? Prof. Dr. W. Ziegler Studiengang Technische Redaktion Hamburg, DokuNord DOKU+MEDIEN FORUM 2011

2 Inhalt Content Management: Überblick und Methoden PI-Klassifikation: Methodik der Metadatenbildung PI-Mod: Informationsmodell und Mechanismen

3 Content Management Überblick und Methoden

4 Verbreitung: CMS Einsatz 2005/2008

5 Anforderungen an CMS Varianten Versionen

6 W or kf lo w Ä M nd (E an eru nt a g n w em gs ic kl en un t g) Te Sp rm ra in c h ol ko og nt iero, lle F (S ach ta l. tu Fr s) ei ga be Sp (S ra ta ch tu l. s) F re ig ab e Genutzte Prozessunterstützung QS

7 Standardmodell zur CMS-Einführung 1. Analyse des IST-Zustandes 2. Darstellung des Optimierungspotenzials 3. Definition der SOLL-Zustandes 4. Evaluierung der Systeme und Auswahl Erstellung eines Pflichtenheftes Content & Media Interne Vorbereitung Engineering Systemanpassung 8. Installation des Systems 9. Schulungsmaßnahmen 10. Systemnutzung 6. 1 Process (Re-) Engineering tekom CMS-Studie 2005/2008

8 Ebenen der Standardisierung Content Engineering (Phase 6) Informationen erfassen: Inhaltlich standardisiert und kontrolliert in logische Einheiten modularisiert nach Informationsmodellen strukturiert mit Metadaten klassifiziert im XML-Datenformat abgelegt Schreibregeln Modularisierungsregeln Informationsmodell Datenformat Zeichenformat

9 Erfahrungswerte der Anwender zum Aufwand Aufgabe sehr hoch hoch mittel gering wird nicht gemacht Altdatenmigration 18,1 % 31,6 % 20,0 % 9,3 % 14,9 % 16,7 % 31,6 % 30,7 % 11,2 % 4,2 % 13,0 % 36,7 % 32,6 % 8,4 % 3,3 % 12,6 % 34,4 % 34,4 % 8,8 % 3,7 % 10,2 % 21,9 % 29,8 % 9,8 % 16,7 % 6,0 % 21,9 % 42,3 % 8,4 % 10,2 % Prozessmodellierung 6,0 % 17,7 % 43,7 % 11,6 % 5,1 % Publikationskonzept 5,6 % 16,3 % 41,9 % 27,0 % 3,7 % Redaktionsleitfaden 5,1 % 24,2 % 39,1 % 16,7 % 6,0 % Grafikkonzept 2,8 % 11,2 % 34,9 % 39,1 % 6,0 % Testsystem 1,4 % 15,8 % 41,4 % 17,2 % 12,6 % Textstandardisierung Strukturierung und (XMLInformationsmodellierung) Modularisierungs- und Variantenkonzept Terminologieextraktion und Pflege Metadatenmodellierung

10 Modularisierungskonzepte Top-down Topics (Themen) Komponenten (Maschinen, Funktionen) Gliederungsorientiert (Kapitel, Unterkapitel) Wiederverwendungsoptimiert (Sätze, Absätze) Bottom-up Kombinationen möglich; Konzept notwendig VOR Systemeinführung

11 Größenverteilung von Modulen Variantenmanagement Fertigung / Stücklisten Standardisierte Infomodelle

12 Evolution von Informationsmodellen StandardStrukturen CMSInfo-Modelle Docbook DITA S1000D PI-Mod 3 (Unternehmens-) spezifische Info-Modelle PI-Mod Project Studiengang Technische Redaktion Prof. Dr. W. Ziegler - HSKA 12

13 Verbreitung von Standards Standardisierung (Content Engineering) Tekom CMS Studie

14 Content-Varianten-Management (CVM) Modulares Variantenmanagement Mehrere Varianten eines Moduls Unterscheidung mit Hilfe von Metadaten Submodulares Variantenmanagement Wiederverwendung von Fragmenten (Sätze, ) Feingranulare Unterscheidung

15 Dokumenterstellung und Variantenmgmt. Maschine 1 Maschine 2 Variante B Variante A Mass Customization

16 Submodulares Variantenmanagement Mehrere Methoden; z.b. Variantensammlung

17 Systemkategorien Anpassungsgrad Lösung Mass Customization Programmierung CMS-Plattform KonfigurationsCMS Konfiguration Redaktions werkzeug Standard CMS Funktionsumfang (Standard)

18 PI-Klassifikation

19 Module und Metadaten?

20 Metadaten: Beispiele ck ) ü l ns G a H r ( e l l te Ers ine l n O t r a ns atio k Arbeit i n l i s b u t a Pu ungsst z t e s r e b Ü ben e e g e ig z e r f üt Status t Dokument s f typ Bordh p andbuch o K pe p Version 4.0 u r g gehörigkeit A, B Zu s n io t k nung ie d e B n t r de nsa e o i h t c a a r m Fu r p o S Inf Fahrzeu gart PK W Tä 6. 4 ti g d n ta z it S ke e t Arbeitss n e it Kompon Au sb B a au u r e i h e g n u 1 t en i 6 9, 245 Anle p y t l u d Mo

21 Metadaten: Systematisierung Ersteller ( Hans Glück ) Übersetzungsstatus in Arbeit Status freigegeben Sprache de Lebenszyklus Version 4.0 Arbeitsstand 4.6 Komponente Sitz Modultyp Anleitung Funktionsgruppe Kopfstütze Informationsart Bedienung Eigenschaft Tätigkeit Ausbauen Produktbezogen Fahrzeugart PKW Zugehörigkeit A, B Baureihe 169, 245 Informationsbezogen Verwendung, Gültigkeit Dokumenttyp Bordhandbuch Publikationsart Online

22 Metadatensystematik im CM Eigen schaft Gültig keit hierarchisch eindeutig/einwertig hierarchisch mehrdeutig/mehrwertig 22

23

24 PI-Klassifikation: Metadaten im CMS Klassifikation der modularen Informationsobjekte nach Produktzuordnung Informationsart Planungsinstrument im Content Engineering Basis für Suche, Ablagestruktur, Selektion und Publikation Notwendig für Automatisierungsprozesse (Stücklistenkopplung, PLM, Serviceportale, )

25 PI-Klassifikation (intrinsisch) PI Modul prodclass prodclas prodclas infoclass1 # 1 s2 1 Oberwage Kabine s3 Einstieg ss2 Beschreibu Aufbau Zahnrad ng Beschreibu TechDa - ng Aufgabe 2 3 n Antrieb Hydraulik Getriebe Ölpumpe infocla t Repara tur Wartun 4 die Druckeinh Farbwerk Farbregle Aufgabe kann bekannte Teileklassifikation abbilden kann Produktlebenzyklus (MaschRL) abbilden eit r g sollte i.a. nicht die Endprodukte benennen (extrinsisch!) Ist Planungsinstrument für verteilte und projektierte Modulerstellung ist unabhängig von CMS und von Info.modell

26 Modulklassifikation in der Praxis Modulmatrix als Planungsinstrument (Content Engineering) 3-stufige intrinsische 4-stufige intrinsische Informationsklassifikation Produktklassifikation Fa. Koenig&Bauer, Druckmaschinenbau

27 Vergabe von Metadaten Nutzung intrinsischer Metadaten, um Module mit Hilfe der Klassifikation auffindbar zu machen: Ablagestruktur Sitz Kopfstütze Ausbau Direkte Vergabe als Attribute Sitz Kopfstütze Einstellen Rückenlehne Ausbau Sitzheizung Kombination: dynamische Verzeichnisse

28 Dokumenterstellung und Variantenmgmt. Gültig für: Maschine 1213 Gültig für: Maschine 1299 Gültig für: Bauteil 23-ST400 Gültig für: Maschine 1213 komponentenbezogene (inrinsisch) Generierung oder Filterung maschinen-/ auftragsbezogene (extrinsisch) Generierung oder Filterung Gültig für: Bauteil Gültig für: 23-SA200 Maschine 1299 Mass Customization

29 Submodulares Variantenmanagement Mehrere Methoden; z.b. Variantensammlung Gültigkeiten intrinsisch oder extrinsisch

30 Submodulares Variantenmanagement Strukturierte Texterfassung Extrinsische Gültigkeiten für ProduktVarianten Modulare Wiederverwendung

31 Das Informationsmodell PI-Mod descriptive glossary task task-intervals Strukturen und Mechanismen lubrication diagnosis tools

32 Allgemeine Ziele Standardisiertes Informationsmodell für einzelne bzw. zusammenhängende Branchen: Maschinen - und Anlagenbau Automatisierung- Elektrobranche Consumerprodukte Zulieferketten (Informationsaustausch) Erstellung von Anwender- und Serviceinformationen Leichte Integration in Redaktionssysteme (implementierungsfrei) Praxisnah und projektgetrieben Anpassbar (Customizing) Open Source (freie Nutzung)

33 Historie: LIEBHERR Informationsmodell DOCU (Semantische) Auszeichnung der Informationen/Tätigkeiten im Produktlebenszyklus Funktionale Informationsmodellierung Konzept seit 1997 bei LIEBHERR im Einsatz Prof. Dr. W. Ziegler TR - HSKA Studiengang Technische Redaktion Prof.Studiengang Dr. W. Ziegler 33

34 PI-Mod Modultypen (V1.2) Modultypen entsprechen 1. Ebene der Infoklasse PI: P roduktklassifikation I nformationklassifikation Mod: Modulare Erfassung von (maschinentypischen) Informationen Beschreibende Info. Diagnose und Fehlerbehebung Anleitende Info. (Aufgabe) Wartungspläne Werkzeuglisten Schmierstoffe und -pläne Glossare

35 Modultyp Beschreibung (descriptive) PI-Metadaten als XML-Attribute am Modul Aufbaubeschreibung Funktionsbeschreibung Technische Beschreibungen (Tech. Daten) Übersichten Einleitungen Relativ freie Modulstruktur mit mischbaren Textelementen: Absatz, Listen, Tabellen, Hinweise, Medien, Daten

36 Beispielinhalte descriptive 36

37 Modultyp Aufgabe/Anleitung (task) Kollektionen-Elemente PI-Metadaten als XML-Attribute am Modul Stark semantische Modulstruktur mit festgelegten handlungsanleitenden Elementen: Orientierungen Voraussetzungen Warnhinweise (bedingte) Handlungsschritte, Resultate

38 Beispielinhalte task 38

39 Spezielle Funktionalitäten (vor Publikation) Kollektionenmechanismus (Wartungspläne) <taskinterval customer= 500h > Staubfilter kontrollieren </taskinterval> task task Aggregation Publikation taskintervals task <taskinterval <taskinterval <taskinterval > > > Analog: Benötigte Arbeitsmittel sammeln (tools) Technische Daten erfassen und konvertieren/lokalisieren <number> 2 </number> <unit> m </unit> <number> 6-6 </number> <unit> ft -in </unit> 39

40 Modultyp Aufgabenübersicht / Wartungsplan (taskintervals) Kollektion von Informationen zu (Wartungs-) häufigkeiten und Tätigkeiten sowie Verantwortlichkeiten Kollektionenmechanismus: Automatisiert aus taskinterval in task-modulen Manuell als eigenes Modul mit taskinterval Manuell als selbsterstellte Tabelle Mischformen

41 Beispielinhalte taskintervals 41

42 Modultyp Schmierstoffe Kollektion von Information zu Schmierstoffen Betriebsmittel Rohstoffe Hilfsmittel Kollektionenmechanismus: Automatisiert aus lubricationlist in task- Modulen Manuell als eigenes Modul Manuell als selbsterstellte Tabelle Mischformen

43 Beispielinhalte lubrication Semantische Modellierung + Generische (CALS) Tabellen 43

44 Modultyp Werkzeuge und Materialien (tools) Kollektion von Informationen zu: Werkzeugen Verbrauchsmaterialien Ersatzteilen Kollektionenmechanismus: Automatisiert aus toolist in taskmodulen Manuell als eigenes Modul mit tool, part Manuell als selbsterstellte Tabelle Mischformen

45 Beispielinhalte tools

46 Modultyp Diagnose Kollektion von: Kurzdiagnosen Hilfe im Problemfall Störungsmeldung und Abhilfe

47 Beispielinhalte diagnosis 47

48 Modultyp Glossar (glossary) Eigenständiger Modultyp für Glossare als Ergänzung zu Publikationen.

49 Beispielinhalte glossary

50 Dokumenterstellung Dokumentbasierte Aggregationsstruktur als einfacher Standard in PI-Mod. Publikationsmechanismen folgen dieser Struktur. Ausprägung in den CMS sehr unterschiedlich. PI-Mod definiert hierzu keine Vorgaben.

51 Beispiel für Dokumentstruktur

52 Implementierungen und Entwicklungen

53 CMS-Implementierungen CMS-Anbieter ( Standard oder PI-Mod Paket ) Docufy (cosima PI-Mod) Fischer Computer Technik (TIM Infomanager) Noxum (Publishing Studio) Ovidius (TCToolbox) Siemens (Hybrix)?

54 Editoren (Erfassung) XMetaL /XMaX (PI-Mod Group, FCT, Docufy) Arbortext (Siemens, ) Publishing Studio XML-Editor (Noxum) FrameMaker ( )

55 PI-Mod ganz alleine Bisher nicht im primären Fokus der Projektgruppe Standalone -Lösung kann aber ein sinnvoller Einstieg in das Content-Engineering sein ( Proof-of-Concept ) Erfassung z.b. mit XMetaL oder Arbortext Editor Print-Publikation über AntennaHouse (ggf. fop) Online-Publikation (HTML, CHM) Verwaltung im Dateisystem

56 Textoptimierung und -kontrolle Funktional motivierte semantische Modellierung Elementkatalog (de, en?) als Teil eines Redaktionsleitfaden Kopplung an Sprachkontrollsysteme

57 Anpassungen ( Customizing ) Systemabhängige Implementierung außerhalb PI-Mod Variantenmanagement Referenzierung (Reuse) Querverweise Aggregation Variablen Projekt- / unternehmensabhängige Anpassung im Standard Metadaten der PI-Klassifikation Wertelisten für taskintervals, u.ä Strukturvereinfachungen Customizing außerhalb des Standards Strukturveränderungen, -ergänzungen Tutorial tekom Jahrestagung 2010, Thesis HSKA

58 Weiterentwicklungen Informationsmaterial/Dokumentation InDesign-Ausgabe Strukturdefinition als XSD (Schema) Elementbeschreibung in unterschiedlichen Sprachen Erweiterung der Struktur für die Dokumentation von Steuerungs-Software Integration/Kopplung in weitere CMS, CLC Support (Dienstleistung) für CMS-Anbieter

59 Projektgruppe und Beteiligte, Unterstützer Technik / Implementierung Projekte, Unterstützung, Unternehmen D. Heideck ABB Stotz Kontakt N. Messaoudi Glatt Dr. H. H. Rath Koenig & Bauer T. Rickmann Putzmeister Concrete Pumps B. Schäfer K. Schrempp G. Blocher (Tanner AG) C. Chmielewski (ABB SK) S. Steurer F. Ully M. Heinz (Liebherr LIS) B. Weinheimer B. Klötzl (Putzmeister) Prof. Dr. W. Ziegler E. Tober (KBA) J. Hennig (KBA) Dokuwerk KG Liebherr IT-Services GmbH ICMS

60 Zusammenfassung Content Management: Überblick und Methoden PI-Klassifikation: Methodik der Metadatenbildung PI-Mod: Strukturen und Mechanismen Literatur: Ziegler/Steurer: Mit PI-Mod dokumentieren, tk 06/10 Drewer/Ziegler: Technische Dokumentation, Vogel (2010)