© 2006 Warum Topic oriented writing? Warum Topic oriented writing?

© 2006 Warum Topic oriented writing? Was sind Topics? Seite 2 ● Topics sind kleine Informationsbrocken, die ein einzelnes Subjekt behandeln - Wissensatomisierung ● Schreiber kümmern sich nur noch um die Beschreibung eines Subjektes ● Topics sind voneinander unabhängig und haben höchstens verwandte Topics

© 2006 Warum Topic oriented writing? Wozu Topics? Seite 3 ● Mit Topic oriented writing lässt sich die Qualität der technischen Dokumentation erhöhen ● Topics fokusierte Texte, die dem Leser schnell seine Frage beantwortet ● Wiederverwendung von Inhalt Vermeidung von Redundanzen durch cut 'n paste, Kostenersparnis

© 2006 Warum Topic oriented writing? Die aktuelle Situation Seite 4 ● Dokumentation ist vielfach eingesperrt in proprietären Formaten ● Dokumentation wird ebenso alt wie die Software, die sie dokumentiert ● Sensibel durch Jahr 2000 Problem ● Wer erinnert sich heute noch an Ami Pro oder Word Perfect

© 2006 Warum Topic oriented writing? Vielfacher Einsatz Seite 5 ● Dokumentation muss heute ebenso flexibel sein wie Software: Software Spezifikation UI Spezifikation Test Spezifikation Tutorial (interaktiv) (Papier, PDF, HTML) Online Hilfe Marketing Material (Papier, PDF, HTML) Service Information (Papier, PDF, HTML) Handbuch (Papier, PDF, HTML) interne Information externe Information

© 2006 Warum Topic oriented writing? cut 'n paste Dokumentation Seite 6 ● Redundante Inhalte ● Bei Änderung eines Dokumentes müssen alle Dokumente nachgezogen werden ● Stille Post in der Dokumentation, vermeintlich gut gemeinte kosmetische Formulierungsänderungen ● Überblick und Kosten laufen aus dem Ruder; die Qualität sinkt

© 2006 Warum Topic oriented writing? Content- und Layouttrennung Seite 7 ● Weg von layoutgetriebenen Ansatz des Schreibens ● Content semantisch auszeichnen ● Beispiel: Prozedur Mache etwas Mache noch etwas Inhalt 1.Mach etwas 2.Mach noch etwas ➔ Mach etwas ➔ Mach noch etwas Layouts

© 2006 Warum Topic oriented writing? Bekanntere Contentmodelle Seite 8 ● Tex, Latex mathematisch, technisch wissenschaftliche Domäne ● Docbook IT Domäne (KDE, Darwin) ● Text Encoding Intiative (TEI) geisteswissenschaftliche Domäne ● mumsay technische Domäne ● DITA IT Domäne (erweiterbar)

© 2006 Warum Topic oriented writing? Docbook Seite 9 ● Sehr mächtig, über 400 Auszeichnungen ● Artikel- und Buchorientiert ● Hierarchische Struktur in Kapiteln und Abschnitten ● Kontextorientiert ● Inhalt lässt sich nicht einfach wieder- verwenden

© 2006 Warum Topic oriented writing? Nächster Schritt Seite 10 ● Trennung von Inhalt und Kontext

© 2006 Warum Topic oriented writing? Was sind Topics? Seite 11 ● Topics sind kleine Informationsbrocken, die ein einzelnes Subjekt behandeln Wissensatomisierung ● Schreiber kümmern sich nur noch um die Beschreibung eines Subjektes ● Topics sind voneinander unabhängig und haben höchstens verwandte Topics ● Transklusion von Topics durch externe Mappinginformationen

© 2006 Warum Topic oriented writing? Topics - Konsequenzen Seite 12 ● Textuelle Referenzen auf externe Topics müssen vermieden werden Beispiele: - Eine Erklärung folgt unten - Wie früher erwähnt wurde...

© 2006 Warum Topic oriented writing? DITA - Darwin Information Typing Architecture Seite 13 ● Darwin - Erweiterung durch Vererbung ist eine der wichtigsten Eigen- schaften von DITA ● Information Typing – Methode zum orga- nisieren von Topics und deren Inhalt. ● Architecture - DITA ist eine Architektur

© 2006 Warum Topic oriented writing? DITA Seite 14 ● DITA wurde von IBM entwickelt Ersatz für das bisherige IBMIDDoc Format auf SGML Basis ● DITA wurde standardisiert von OASIS ● DITA ist offen und anpassbar ● Wachsende Industrieunterstützung Adobe Creative Suite 2 Dokumentation (Photoshop, Illustrator, Go Live usw.) Nokia, Blast Radius

© 2006 Warum Topic oriented writing? DITAs Topicspzialisierung Seite 15 ● DITA unterscheidet bereits in der ersten Version zwischen 3 verschiedenen Topics Task (Wie mache ich...?) Concept (Was ist...?) Reference (Inhalt, Stückliste) Topic

© 2006 Warum Topic oriented writing? DITA - Beispiel Seite 16 ● Ein Beispiel aus dem Leben, abseits der Arbeit ● Was sind Tapas? ● Was ist Salmorejo? ● Zutatenliste für Salmorejo ● Wie wird Salmorejo zubereitet? Concept Reference Task

© 2006 Warum Topic oriented writing? DITA - Mapping Seite 17 ● Mappings bauen die atomisierten Wissen- artefakte wieder zusammen ● Mappings können auch Buchstrukturen abbilden Conc ept Task Ref Conc ept Task Conc ept Mapping - Was sind Tapas? - Was ist Salmorejo? - Zutatenliste für Salmorejo? - Zubereitung von Salmorejo? Conc ept Mapping - Was ist die spanische Küche? - Was sind Tapas? - Was ist Salmorejo? - Was ist Paella?

© 2006 Warum Topic oriented writing? DITA - Wiederverwendung Seite 18 XM L CM S DIT A XSL T PD F HTM L XHTM L RT F

© 2006 Warum Topic oriented writing? Kritik an DITA Seite 19 ● Yet another Content model ● Docbook kann das auch... Mit ein paar Hacks... ● Docbook hat 10 Jahre mehr Erfahrung in der Toolchain ● DITA Toolkit wandelt auch in Docbook um ● DITA Toolchain nur XSLT basiert ● Umwandlung in troff kompatibles Format möglich

© 2006 Warum Topic oriented writing? Topics und Wikis Seite 20 ● Wikis sind reine Online-Systeme ● Wikis sind stark vernetzt, dadurch kann man sie nur als Ganzes verwenden ● Wikis haben keine komplexen semantischen Auszeichnungen

© 2006 Warum Topic oriented writing? DITA Quellen Seite 21 ● DITA bei ● DITA Open Toolkit, Referenzimplementierung ● DeveloperWorks Artikel zu DITA ● Coverpage ● Erste Erfahrungen mit DITA