Modularisierung in der Technischen Dokumentation - Zindel AG
Modularisierung in der Technischen Dokumentation - Zindel AG
Modularisierung in der Technischen Dokumentation - Zindel AG
Sie wollen auch ein ePaper? Erhöhen Sie die Reichweite Ihrer Titel.
YUMPU macht aus Druck-PDFs automatisch weboptimierte ePaper, die Google liebt.
<strong>Modularisierung</strong><br />
<strong>in</strong> <strong>der</strong> <strong>Technischen</strong> <strong>Dokumentation</strong><br />
Grundlagen und Methoden<br />
ZINDEL <strong>AG</strong>, Hamburg<br />
14. Februar 2007<br />
Prof. Dr. W. Ziegler (HsKA)
Warum <strong>Modularisierung</strong>?<br />
• Wie<strong>der</strong>verwendung!<br />
• Inhaltskontrolle<br />
• Strukturkontrolle<br />
• Prozesskontrolle<br />
• Kosteneffizienz<br />
• Zeiteffizienz<br />
}QS<br />
Output (Menge, Qualität)<br />
CM<br />
E<strong>in</strong>gesetzte Ressourcen<br />
(Zeit, Geld)<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 2
E<strong>in</strong>satz von Content Management Systemen<br />
60<br />
50<br />
40<br />
30<br />
20<br />
10<br />
0<br />
Informationsphase<br />
50,4%<br />
Entscheidungsphase<br />
6,7% 7,2%<br />
Entscheidung gegen CMS<br />
Entscheidung für CMS<br />
35,7%<br />
tekom<br />
2005<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 3
Redaktionsprozesse im Content Lifecycle<br />
Bsp: Danfoss<br />
* **<br />
Module Module Dokumente<br />
Retrieval QS Publizieren Archiv.<br />
klassifizieren erfassen erstellen<br />
** ** *<br />
Versionierung, Varianten, …<br />
***<br />
TMS ** ***<br />
* ***<br />
Sprachen<br />
***<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 4<br />
*<br />
***<br />
Zielgruppen Medien Dokutypen
Standardisierung<br />
*,**<br />
**<br />
**<br />
***<br />
***<br />
Betroffene Prozesse: QS<br />
Leitfaden + Term- und Textkontrolle<br />
Methodik + Klassifikation<br />
Methodik + DTD/XSD<br />
Editoren + XML<br />
Editoren + Unicode<br />
Module<br />
klassifizieren<br />
Grafik/Medien-Standardisierung analog!<br />
Module<br />
erfassen<br />
Schreibregeln<br />
<strong>Modularisierung</strong>sregeln<br />
Informationsmodell<br />
Datenformat<br />
Zeichenformat<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 5
Spektrum <strong>der</strong> Modulgröße<br />
Database<br />
Publish<strong>in</strong>g<br />
PC-DB /<br />
Office<br />
Modulgröße<br />
Daten CMS Kapitel Dokument<br />
Manag<strong>in</strong>g<br />
XML-<br />
Module<br />
Modulares<br />
DTP<br />
}DB-<br />
System<br />
}Datei-<br />
System<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 6
Konsequenzen <strong>der</strong> <strong>Modularisierung</strong><br />
Verwaltungsaufwand<br />
Komplexität<br />
Flexibilität<br />
(Höhere<br />
Wie<strong>der</strong>verwendung)<br />
Modulgröße<br />
Redundanzen<br />
(Ger<strong>in</strong>gere Wie<strong>der</strong>verwendung)<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 7
%<br />
60<br />
40<br />
20<br />
0<br />
Daten<br />
Größenverteilung von Modulen<br />
Sätze<br />
Absätze<br />
Seiten<br />
Komponenten<br />
Kapitel<br />
Nicht modular<br />
tekom CMS-<br />
Studie 2005<br />
DOG 2000<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 8
Vorgehensweisen<br />
Bottom-Up-Analyse vs. Top-Down-Methoden<br />
!<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 9
Bottom-Up-Analyse I<br />
Modulidentifikation durch Dokumentenvergleich<br />
!<br />
!<br />
Standard<br />
Option<br />
Variante<br />
Content-Variante<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 10<br />
!
Bottom-Up-Analyse I : Dokument-Matrix<br />
Dokumentstruktur<br />
Kap. 1<br />
Kap. 2<br />
Kap. 3<br />
Dok 1<br />
Mod 1<br />
(S)<br />
Rockley 2003 „Content Audit“<br />
Dok 2<br />
Mod 1<br />
(S)<br />
Mod 2<br />
(V)<br />
Mod 4<br />
(O)<br />
Dok 3<br />
Mod 1<br />
(S)<br />
Mod 3<br />
(V)<br />
Dok. ,Medien, Zielgruppen<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 11
Konsequenzen <strong>der</strong> <strong>Modularisierung</strong><br />
• Modulvarianten entsprechen nicht immer den Produktvarianten<br />
• Option ist e<strong>in</strong>e e<strong>in</strong>wertige Variante<br />
• Es existieren Varianten von optionalen Modulen<br />
• Die Unterscheidung zwischen optionalem und variablem Modul<br />
hängt an <strong>der</strong> Modulgröße!<br />
Matrixdarstellung ist (nur) <strong>der</strong> Verwendungsnachweis von<br />
Modulen, ke<strong>in</strong>e e<strong>in</strong>deutige Modellierungsvorgabe<br />
!<br />
! !!<br />
Ablage+Kennzeichnung<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 12
Bottom-Up-<strong>Modularisierung</strong> II (Software-Doku.)<br />
Analyse und Modulbildung nach Ament<br />
• „First, s<strong>in</strong>gle sourc<strong>in</strong>g ist a methodology, not a technology.<br />
Although s<strong>in</strong>gle sourc<strong>in</strong>g can <strong>in</strong>volve very complex<br />
technologies, modular writ<strong>in</strong>g is what drives the process. „<br />
• „Second, modular documentation is not possible without<br />
standardization. Writ<strong>in</strong>g standards that are `nice to have` <strong>in</strong><br />
l<strong>in</strong>ear documentation become `must have` <strong>in</strong> s<strong>in</strong>gle sourc<strong>in</strong>g.<br />
To develop modular content … you need writ<strong>in</strong>g guidel<strong>in</strong>es<br />
that answer usability and re-usability questions directly.<br />
Ament (2003), „S<strong>in</strong>gle Sourc<strong>in</strong>g - Build<strong>in</strong>g Modular Documentation“<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 13
Bottom-Up-<strong>Modularisierung</strong> II<br />
10-stufige Methodik nach Ament (2003)<br />
1. Module identifizieren<br />
2. Module benennen<br />
3. Module organisieren<br />
4. Module erfassen<br />
5. Module editieren<br />
6. Dokumente aufbauen<br />
7. Verweise erstellen<br />
8. Dokumente konvertieren<br />
9. Dokumente testen<br />
10. Leitfaden entwickeln<br />
SSP/Ament_SS_chapter2_2003.pdf<br />
(Text <strong>in</strong> Module aufteilen)<br />
(Modultitel vergeben)<br />
(Untermodule <strong>in</strong>tegrieren,<br />
Hauptmodule ablegen)<br />
(Texte schreiben, formatieren)<br />
(Mediales und QS-Lektorat)<br />
(Module zusammenbauen)<br />
(IHVZ, Glossar, L<strong>in</strong>ks)<br />
(Verschiedene Formate)<br />
(Usabilitytest <strong>der</strong> Texte)<br />
(Regeln aus 1-9 ableiten)<br />
Ament (2003), „S<strong>in</strong>gle Sourc<strong>in</strong>g - Build<strong>in</strong>g Modular Documentation“<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 14
Bottom-Up-<strong>Modularisierung</strong> II<br />
Module identifizieren: Ament (2003)<br />
Primäre Module<br />
E<strong>in</strong>teilung nach Modultypen<br />
entsprechend <strong>der</strong> (Unter-) Kapitel<br />
Sekundäre Module<br />
Extraktion nach funktionalen<br />
Aspekten<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 15
Top-Down-<strong>Modularisierung</strong> I: VDW<br />
3-stufige <strong>Modularisierung</strong>smethodik<br />
(für Betriebsanleitungen / Masch<strong>in</strong>en- und Anlagenbau)<br />
1. Grundstruktur<br />
Kapitel <strong>der</strong> Anleitung nach rechtlichen Vorgaben und<br />
Produktlebenszyklus glie<strong>der</strong>n<br />
VDW\Kurz<strong>in</strong>formationen spez T1.pdf, tekom Leitfaden Betriebsanleitungen<br />
2. Fe<strong>in</strong>struktur<br />
Module <strong>in</strong> Dokumentenmatrix e<strong>in</strong>ordnen<br />
Matrix wird aufgespannt aus Dokument- und Produktstruktur<br />
3. Modulstruktur<br />
Schreib- und Formatierungsregeln standardisieren<br />
VDW\Kurz<strong>in</strong>formationen spez T2.pdf<br />
Style Guide als Ergebnis <strong>der</strong> VDW-Studie (Zu 1. und 3.): VDW\Style Guide.pdf<br />
Pfeifer, Lorenzi, Schmidt, „Betriebsanleitungen modular aufbauen“, technische komunikation 2/2002, S. 19<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 16
Dokumentenmatrix Produktstruktur vs. Dok.struktur<br />
Voraussetzung<br />
für automatisierte<br />
(stücklistengetriebene)Dokumentgenerierung<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 17<br />
1<br />
3 2<br />
4<br />
Basis für<br />
klassifizierende<br />
Metadaten<br />
(Gültigkeiten)
Umsetzung im Informationsmodell DOCU<br />
(Semantische) Auszeichnung <strong>der</strong><br />
Informationen/Tätigkeiten im Produktlebenszyklus<br />
Funktionale Informationsmodellierung<br />
Konzept seit 1997 bei LIEBHERR im E<strong>in</strong>satz<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 18
<strong>Modularisierung</strong> VDW<br />
Erläuterung: VDW\Präsentationsfolien.pdf (Seite 46-49)<br />
• Def<strong>in</strong>ition unabhängig von<br />
Informationsmodell<br />
• Konzentration auf e<strong>in</strong>en Aspekt des<br />
CMP (zweidimensionale Matrix!)<br />
• Variantenmanagement als zusätzliche<br />
Methodik zu erarbeiten<br />
• Produktstruktur u.U. nicht<br />
stücklistenbasiert<br />
Pfeifer et al., technische komunikation 2/2002, S. 19<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 19
Top-Down-<strong>Modularisierung</strong> II<br />
<strong>Modularisierung</strong> gemäß standardisierten<br />
Informationsmodellen und -prozessen<br />
• Docbook<br />
• S1000D<br />
• Mumasy<br />
• DITA<br />
…….<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 20
S1000D ASD/AIA (Luftfahrt/Militär)<br />
Data Modules (DM):<br />
• Procedure<br />
• Descriptive<br />
• Parts Data<br />
•….<br />
Data Module Code<br />
(DMC) und<br />
Informationsmodell<br />
(s.57 ff)<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 21
DITA Darw<strong>in</strong> Information Typ<strong>in</strong>g Architecture<br />
• OASIS-Standard seit 2005<br />
• Topic-orientierte Informationserfassung <strong>in</strong> Modulen<br />
• Vererbungs- und Spezialisierungsmechanismen für Anpassung an<br />
firmenspezifische Anfor<strong>der</strong>ungen<br />
• Publikation primär <strong>in</strong> Onl<strong>in</strong>e-Medien und Help-Systeme<br />
• Zunehmend Literatur, Dienstleistungen und (freie) Tools<br />
DITA/DITA-IntroductionBrief.ppt<br />
http://www.oasis-open.org/committees/dita/<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 22
Top-Down-<strong>Modularisierung</strong> III<br />
<strong>Modularisierung</strong> <strong>in</strong> Abhängigkeit von<br />
sprach-zentrierten Theorien/Methoden<br />
• Funktionsdesign (Sprechakt-Theorie)<br />
Sprachlich-Funktionale E<strong>in</strong>heiten und Sequenzmuster<br />
• Information-Mapp<strong>in</strong>g (Kognitions-Psychologie)<br />
Wahrnehmungsoptimierte Informationsgrößen<br />
und -strukturen<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 23
Primäre <strong>Modularisierung</strong><br />
• Meist <strong>in</strong> sich abgeschlossene E<strong>in</strong>heiten<br />
• Die Größe ergibt sich aus den angewandten Kriterien und ziele<br />
<strong>der</strong> (top-down o<strong>der</strong> bottom-up) Methode:<br />
– Wie<strong>der</strong>verwendungshäufigkeit<br />
– Topic-Orientierung<br />
– Informationsmanagement entlang Produktlebenszyklus<br />
– Informationsmodellierung (FD, IMAP, ….)<br />
– Automatisierung/Kopplung an ERP<br />
• Son<strong>der</strong>fälle, u.a.<br />
– Seitenorientierung<br />
– Fremddokumentation<br />
– Satzweise Wie<strong>der</strong>verwendung<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 24
Modulbildung auf allen Ebenen<br />
Wie<strong>der</strong>verwendung kann <strong>in</strong> allen Größenordungen s<strong>in</strong>nvoll se<strong>in</strong>:<br />
Dokument<br />
Kapitel<br />
S<strong>in</strong>ne<strong>in</strong>heit (Topic / Funktionale E<strong>in</strong>heit)<br />
Satz<br />
Wort<br />
Daten<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 25
Content-Varianten<br />
Grundproblem <strong>der</strong> Redundanz bleibt bei Modulbildung<br />
potenziell auf allen Ebenen erhalten!<br />
Reuse?<br />
wenig Redundanz<br />
viel Redundanz<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 26
Redundanz<br />
(<strong>in</strong>nerhalb Unterkapitel / Komponenten-Modul)<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 27
Redundanz<br />
(<strong>in</strong>nerhalb Absatz / Funktionaler E<strong>in</strong>heit)<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 28
Redundanz<br />
(<strong>in</strong>nerhalb Satz / Funktionaler E<strong>in</strong>heit)<br />
……….<br />
Die Neigung <strong>der</strong> Rückenlehne wird mit dem Hebel 1 an <strong>der</strong><br />
rechten Seite des Sitzes e<strong>in</strong>gestellt.<br />
……….<br />
……….<br />
Die Neigung <strong>der</strong> Rückenlehne wird mit dem Hebel 2 an <strong>der</strong><br />
l<strong>in</strong>ken Seite des Sitzes e<strong>in</strong>gestellt.<br />
……….<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 29
Methoden für Content-Varianten<br />
• Vererbung ***<br />
• Reuse Pool *<br />
• Variantensammlung ***<br />
• Lebende Kopie *<br />
• Fragmentierter Reuse **<br />
W. Ziegler, technische kommunikation 3/2005<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 30
Content-Varianten: Vererbung<br />
Reuse<br />
Klasse Modul<br />
Automatischer Reuse durch „Vererbung“ von Klassen<strong>in</strong>formationen.<br />
Ergänzung von weiteren Informationen.<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 31
Content-Varianten: Reuse-Pool<br />
Reuse<br />
Reuse-Pool Modul<br />
Manuelle Auswahl und Reuse e<strong>in</strong>zelner Elemente aus dem Reuse-Pool.<br />
Ergänzungen von weiteren Informationen möglich.<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 32<br />
?
Content-Varianten: Variantensammlung<br />
Variantensammlung<br />
Gültigkeiten <strong>der</strong> Elemente für zwei Typen o<strong>der</strong> Zielgruppen A und B.<br />
Auswertung erfolgt bei <strong>der</strong> Publikation.<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 33<br />
(A)<br />
(A,B)<br />
(B)<br />
(A,B)<br />
(A,B)<br />
(A)<br />
Typ<br />
A<br />
B<br />
Pos<br />
1<br />
2<br />
Richtung<br />
rechts<br />
l<strong>in</strong>ks
Zwischenresumée<br />
<strong>Modularisierung</strong> und Content-Varianten<br />
1. <strong>Modularisierung</strong>sschema und Modulgröße gemäß<br />
• Wie<strong>der</strong>verwendungsrate und Än<strong>der</strong>ungshäufigkeit<br />
• Dokumentstruktur(en)<br />
• Produktvarianten<br />
• Funktionalem Ansatz<br />
2. Content-Varianten bzgl.<br />
• Komponenten (Varianten)<br />
• Zielgruppe<br />
• Medium<br />
• Sprache<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 34
Def<strong>in</strong>ition von Meta-Informationen<br />
Meta-Informationen bilden Redaktionsprozesse ab:<br />
Content-Lifecycle<br />
Klassifikation<br />
Die Redaktionsprozesse hängen von (expliziten und impliziten) Meta-<br />
Informationen ab!<br />
Objekt-Beziehungen lassen sich über Meta-Informationen erkennen und<br />
visualisieren!<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 35
Meta-Daten <strong>der</strong> Klassifikation<br />
Darstellung von Meta-Daten (Verwendungsorientiert / Gültigkeiten)<br />
Hierarchische<br />
Meta-Daten<br />
Golf<br />
Golf<br />
Bora<br />
Bora<br />
Kopfst.<br />
Kopfst.<br />
h<strong>in</strong>ten<br />
h<strong>in</strong>ten<br />
Kopfst.<br />
Kopfst.<br />
vorne<br />
vorne<br />
Kopfst.<br />
Kopfst.<br />
h<strong>in</strong>ten<br />
h<strong>in</strong>ten<br />
Kopfst.<br />
Kopfst.<br />
vorne<br />
vorne<br />
92<br />
92<br />
92<br />
92<br />
92<br />
92<br />
92<br />
92<br />
„Dynamische Verzeichnisse“<br />
K. h.<br />
K. h.<br />
K. v.<br />
K. v.<br />
Golf<br />
Golf<br />
Bora<br />
Bora<br />
Golf<br />
Golf<br />
Bora<br />
Bora<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 36<br />
92<br />
92<br />
92<br />
92<br />
92<br />
92<br />
92<br />
92
Entwicklung e<strong>in</strong>es Modulkonzeptes<br />
Kriterien Aufgabe Ergebnis<br />
Wie<strong>der</strong>holung<br />
Än<strong>der</strong>ungshäufigkeit<br />
Produktstruktur (ERP)<br />
Dok.redundanzen<br />
Produktart<br />
Info.arten<br />
Dokumenttypen<br />
Produktvarianten<br />
Mod.redundanzen<br />
Automatisierung<br />
Dok.analyse<br />
Moduldef<strong>in</strong>ition<br />
Info.modellierung<br />
Variantenanalyse<br />
Metadatendef<strong>in</strong>ition<br />
Dok.matrix<br />
Dok.matrix.<br />
Dok.vorlagen<br />
DTD, XSD, DOT,…<br />
Mod-Varianten<br />
Klassifikation<br />
(Dok.struktur – Produkte)<br />
(Prod.struktur – Dok.Struktur)<br />
Schreib-/Strukturierungsrichtl<strong>in</strong>ien<br />
Unter-Module (Reuse-Pool),<br />
Variablen, Parameter<br />
Ablagestruktur,<br />
Metadaten (Gültigkeiten)<br />
Prof. Dr. W. Ziegler - Grundlagen <strong>der</strong> <strong>Modularisierung</strong> - 14. Februar 2007 37
Change language