PI- und die Doku wird rund - zindel.demedien-forum 2011/B1_PI... · 11.05.2009 · π PI- und die...

PI- und die Doku wird rundππWas bringt das PI-Konzept für die Praxis?

Prof. Dr. W. Ziegler

Studiengang Technische Redaktion

Hamburg, 24.02.2011

DokuNord DOKU+MEDIEN FORUM 2011

© Prof. Dr. W. Ziegler - HSKA Studiengang Technische Redaktion

Inhalt

• Content Management: Überblick und Methoden

• PI-Klassifikation: Methodik der Metadatenbildung

• PI-Mod: Informationsmodell und Mechanismen


Content Management

Überblick und Methoden


Verbreitung: CMS Einsatz 2005/2008


Anforderungen an CMS

Varianten

Versionen


Genutzte Prozessunterstützung

Term

inolo

gie-,

Sprach

kontro

lle

Änderungs-

Man

agem

ent

(Entw

ickl

ung)

Work

flow

Fachl.

Freig

abe

(Sta

tus)

Sprach

l. Fre

igab

e

(Sta

tus)

QS


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

5. Erstellung eines Pflichtenheftes

6. Interne Vorbereitung

7. Systemanpassung

8. Installation des Systems

9. Schulungsmaßnahmen

10. Systemnutzung

12

34

56

78

910

Process (Re-) Engineering

tekom CMS-Studie 2005/2008

Content & MediaEngineering


Ebenen der StandardisierungContent Engineering (Phase 6)

Datenformat

Zeichenformat

Modularisierungsregeln

Schreibregeln

Informationsmodell

Informationen erfassen:

• Inhaltlich standardisiert und kontrolliert • in logische Einheiten modularisiert • nach Informationsmodellen strukturiert• mit Metadaten klassifiziert• im XML-Datenformat abgelegt


Erfahrungswerte der Anwender zum Aufwand

Aufgabe sehr hoch hoch mittel geringwird nichtgemacht

Altdatenmigration 18,1 % 31,6 % 20,0 % 9,3 % 14,9 %

Textstandardisierung16,7 % 31,6 % 30,7 % 11,2 % 4,2 %

Strukturierung und (XML-Informationsmodellierung) 13,0 % 36,7 % 32,6 % 8,4 % 3,3 %

Modularisierungs- und Variantenkonzept 12,6 % 34,4 % 34,4 % 8,8 % 3,7 %

Terminologieextraktion undPflege 10,2 % 21,9 % 29,8 % 9,8 % 16,7 %

Metadatenmodellierung6,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 %


Modularisierungskonzepte

• Topics (Themen)• Komponenten (Maschinen, Funktionen)

• Gliederungsorientiert (Kapitel, Unterkapitel)• Wiederverwendungsoptimiert (Sätze, Absätze)

Kombinationen möglich; Konzept notwendig VOR Systemeinführung

Top-down

Bottom-up


Größenverteilung von Modulen

Fertigung /Stücklisten

StandardisierteInfomodelle

Varianten-management


2

113

DocbookDITAS1000D

(Unternehmens-)spezifische Info-Modelle

CMS-Info-Modelle

Evolution von Informationsmodellen

Standard-Strukturen

PI-Mod

05.11.2009 12PI-Mod Project


Verbreitung von Standards

Standardisierung (Content Engineering)

TekomCMS Studie 2008

13


Content-Varianten-Management (CVM)

• Modulares Variantenmanagement– Mehrere Varianten eines Moduls– Unterscheidung mit Hilfe von Metadaten

• Submodulares Variantenmanagement

– Wiederverwendung von Fragmenten (Sätze,…)

– Feingranulare Unterscheidung


Dokumenterstellung und Variantenmgmt.

Variante B

Variante A

MassCustomization

Maschine 1

Maschine 2


Submodulares Variantenmanagement

Mehrere Methoden; z.B.„Variantensammlung“


Anpassungsgrad

Redaktionswerkzeug

Standard CMS

CMS-Plattform

Lösung MassCustomization

Programmierung

Konfiguration

Funktionsumfang(Standard)

Systemkategorien

Konfigurations-CMS


PI-Klassifikation


Module und Metadaten?


Metadaten: Beispiele

Ersteller („Hans Glück“)

Version „4.0“

Arbeitsstand „4.6“ Tätigkeit „Ausbauen“

Informationsart „Bedienung“

Modultyp„Anleitung“

Komponente „Sitz “

Funktionsgru

ppe „Kopfst

ütze“

Zugehörigkeit „A“, „B“

Baureihe „169“, „245“

Publikationsart „Online“

Dokumenttyp „Bordhandbuch“

Status „freigegeben “Übersetzungsstatus „in Arbeit“

Sprache „de“

Fahrzeugart „PKW“


Metadaten: Systematisierung

Ersteller („Hans Glück“)

Version „4.0“ Arbeitsstand „4.6“

Tätigkeit „Ausbauen“

Informationsart „Bedienung“

Modultyp „Anleitung“Komponente „Sitz “

Funktionsgruppe „Kopfstütze“

Zugehörigkeit „A“, „B“

Baureihe „169“, „245“Publikationsart „Online“

Dokumenttyp „Bordhandbuch“

Status „freigegeben “

Übersetzungsstatus „in Arbeit“

Sprache „de“

Fahrzeugart „PKW“

„Lebens- zyklus“

„Eigenschaft“

„Verwendung“, „Gültigkeit“

„Produktbezogen“ „Informationsbezogen“


Metadatensystematik im CM

22

• hierarchisch• eindeutig/einwertig

• hierarchisch• mehrdeutig/mehrwertig

„Eigenschaft“

„Gültigkeit“


• 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, …)

PI-Klassifikation: Metadaten im CMS


• kann die bekannte Teileklassifikation abbilden• kann Produktlebenzyklus (MaschRL) abbilden• 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

PI-Klassifikation (intrinsisch)

Modul#prodclass1

prodclass2

prodclass3

infoclass1 infoclass2

1 Oberwagen

Kabine Einstieg Beschreibung

Aufbau

2 Antrieb Getriebe Zahnrad Beschreibung

TechDat

3 Hydraulik Ölpumpe - Aufgabe Reparatur

4 Druckeinheit

Farbwerk Farbregler

Aufgabe Wartung

PI


Modulklassifikation in der Praxis

4-stufige intrinsischeProduktklassifikation

3-stufige intrinsischeInformationsklassifikation

Fa. Koenig&Bauer,Druckmaschinenbau

Modulmatrix als Planungsinstrument (Content Engineering)


• Nutzung intrinsischer Metadaten, um Module mit Hilfe der Klassifikation auffindbar zu machen: – Ablagestruktur

– Direkte Vergabe als „Attribute“

– Kombination: „dynamische Verzeichnisse“

Vergabe von Metadaten

Sitz

Kopfstütze

Ausbau

Sitz Kopfstütze

Rückenlehne

Sitzheizung

Einstellen

Ausbau


Dokumenterstellung und Variantenmgmt.

Gültig für:Bauteil 23-ST400

Gültig für:Bauteil 23-SA200

komponenten-bezogene(inrinsisch)Generierung oder Filterung

MassCustomization

Gültig für:Maschine 1213




maschinen-/ auftrags-bezogene(extrinsisch)Generierung oder Filterung



Mehrere Methoden; z.B.„Variantensammlung“

Gültigkeitenintrinsisch oder extrinsisch



StrukturierteTexterfassung

ExtrinsischeGültigkeitenfür Produkt-Varianten

Modulare Wieder-verwendung


descriptivedescriptive glossaryglossary

diagnosisdiagnosis

lubricationlubrication

toolstools

tasktask task-intervalstask-intervals

Das Informationsmodell PI-Mod

Strukturen und

Mechanismen


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)

© Prof. Dr. W. Ziegler - HSKA Studiengang Technische RedaktionProf. Dr. W. Ziegler Studiengang TR 33

Konzept seit 1997 bei LIEBHERR im Einsatz

Historie: LIEBHERR Informationsmodell „DOCU“

(Semantische) Auszeichnung der Informationen/Tätigkeiten im Produktlebenszyklus

Funktionale Informationsmodellierung


PI-Mod Modultypen (V1.2)

PI:P roduktklassifikationI nformationklassifikation

Mod:Modulare Erfassung von(maschinentypischen) Informationen

• Beschreibende Info.• Diagnose und Fehlerbehebung• Anleitende Info. (Aufgabe)• Wartungspläne• Werkzeuglisten• Schmierstoffe und -pläne• Glossare

Modultypen entsprechen1. Ebene der Infoklasse


Modultyp „Beschreibung“ (descriptive)

• Aufbaubeschreibung• Funktionsbeschreibung• Technische Beschreibungen (Tech. Daten)• Übersichten• Einleitungen• …

Relativ freie Modulstruktur mit mischbaren Textelementen:Absatz, Listen, Tabellen, Hinweise, Medien, Daten

PI-Metadatenals XML-Attribute am Modul


Beispielinhalte „descriptive“

36


Modultyp „Aufgabe/Anleitung“ (task)

„Kollektionen-Elemente“

Stark semantische Modulstruktur mit festgelegten handlungsanleitenden Elementen:

• Orientierungen• Voraussetzungen• Warnhinweise• (bedingte) Handlungsschritte,• Resultate• …

PI-Metadatenals XML-Attribute am Modul


Beispielinhalte „task“

38


Spezielle Funktionalitäten (vor Publikation)

• Kollektionenmechanismus (Wartungspläne)

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

tasktask

task

taskintervals

Aggregation Publikation

<taskinterval customer=„500h“>

Staubfilter kontrollieren</taskinterval>

<taskinterval … ><taskinterval … ><taskinterval … >


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


Beispielinhalte „taskintervals“

41


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


Beispielinhalte lubrication

Semantische Modellierung +Generische (CALS) Tabellen

43


Modultyp „Werkzeuge und Materialien“(tools)

Kollektion von Informationen zu:• Werkzeugen• Verbrauchsmaterialien • Ersatzteilen

Kollektionenmechanismus:• Automatisiert aus toolist in task- Modulen• Manuell als eigenes Modul mit tool, part• Manuell als selbsterstellte Tabelle• Mischformen


Beispielinhalte „tools“


Modultyp „Diagnose“

Kollektion von: • Kurzdiagnosen• Hilfe im Problemfall• Störungsmeldung und Abhilfe


Beispielinhalte „diagnosis“

47


Modultyp „Glossar“ (glossary)

Eigenständiger Modultyp für Glossare als Ergänzung zu Publikationen.


Beispielinhalte „glossary“


Dokumenterstellung

Dokumentbasierte Aggregationsstruktur als einfacher Standard inPI-Mod.

Publikationsmechanismenfolgen dieser Struktur.

Ausprägung in den CMSsehr unterschiedlich.PI-Mod definiert hierzukeine Vorgaben.


Beispiel für Dokumentstruktur


Implementierungen und Entwicklungen


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)– …?


Editoren (Erfassung)

• XMetaL /XMaX (PI-Mod Group, FCT, Docufy)• Arbortext (Siemens, …)

• Publishing Studio XML-Editor (Noxum)

• FrameMaker (…)


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


Textoptimierung und -kontrolle

• Funktional motivierte semantische Modellierung

• Elementkatalog (de, en?) als Teil eines Redaktionsleitfaden

• Kopplung an Sprachkontrollsysteme


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


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


Projektgruppe und Beteiligte, Unterstützer

• D. Heideck

• N. Messaoudi

• Dr. H. H. Rath

• T. Rickmann

• B. Schäfer

• K. Schrempp

• S. Steurer

• F. Ully

• B. Weinheimer

• Prof. Dr. W. Ziegler

• ABB Stotz Kontakt

• Glatt

• Koenig & Bauer

• Putzmeister Concrete Pumps• …

• G. Blocher (Tanner AG)

• C. Chmielewski (ABB SK)

• J. Hennig (KBA)

• M. Heinz (Liebherr LIS)

• B. Klötzl (Putzmeister)

• E. Tober (KBA)• …

• Dokuwerk KG

• Liebherr IT-Services GmbH

• ICMS

Technik / Implementierung Projekte, Unterstützung, Unternehmen


Zusammenfassung

• Content Management: Überblick und Methoden

• PI-Klassifikation: Methodik der Metadatenbildung

• PI-Mod: Strukturen und Mechanismen

Literatur:

– www.pi-mod.de

– Ziegler/Steurer: „Mit PI-Mod dokumentieren“, tk 06/10

– Drewer/Ziegler: „Technische Dokumentation“, Vogel (2010)

PI- und die Doku wird rund - zindel.demedien-forum 2011/B1_PI... · 11.05.2009 · π PI- und die...

Documents

Transcript of PI- und die Doku wird rund - zindel.demedien-forum 2011/B1_PI... · 11.05.2009 · π PI- und die...