Vorläufiger Entwurf für eine leichter verdauliche Einleitung:
"... DITA ist ein XML Dialekt mit einer strikten Trennung von Inhalt und Layout Informationen.
Die kleinste Informationseinheit der DITA Specifikation ist ein Topic. Ein DITA Topic ist eine Begriffserklärung. Also ein Glossareintrag. Ein Glossareintrag innerhalb einer Glossarsammlung. Z.B. hier der Glossar von Blender.
Jeder Glossareintrag/jedes Topic steht für sich allein und ist ohne zusätzliche Kontextinformation verständlich. Ein Glossareintrag erklärt immer nur einen Begriff bzw. Schlüsselwort. Damit werden Topics/Glossareinträge wiederverwendbar.
Es gibt drei DITA Topic/Glossartypen die in einer technischen Dokumentation immer wieder vorkommen:
* concept für Hintergrundinformationen
* Reference z.B. Kommandos
* tasks für Schritt-für-Schritt Anleitungen.
Durch die sogenannte Specialisation können eigene Topic/Glossareintrag Typen erstellt werden (fortgeschritten)
Verknüpft bzw. angeordnet werden die Topics/Glossareintrag mittels sogenannter DITA-Maps.
Eine DITA-konforme Dokumentation besteht aus einer Vielzahl von hierarchiefreien Glossar-Einträgen, welche je nach Aufgabenstellung und Zielgruppe zur Zusammenstellung einer hierarisch orientierten Dokumentation zusammengestellt werden. Die inhaltlich zusammengestellte Dokumentation ist somit hierarchieorientiert.
Zuerst wird die Zielgruppe bestimmt. Dafür bieten sich sogenannte Use Cases an. In einer Art Brainstorming werden relevante Schlüsselwörter gesammelt bzw. später hinzugefügt. Hierbei ist "Mut zur Lücke" das Vorgehensprinzip. Danach werden diese zielgruppenrelevante Schlüsselwörter als Glossareinträge beschrieben und mit Metadaten z.B. Computeranfänger, Profi o.ä. versehen.
Nun werden thematisch ähnliche Glossareinträge in inhaltlichen Klassen geordnet. Zur Verwaltung von einer Vielzahl von Glossareinträgen sind die Glossareinträge bzw. deren Metadaten zwingend von einer Desktopsuche Software zu indexieren.
Über diese Indexliste der Glossareinträge oder der Klassenzuordnung wird eine hierarische Glossarsammlung bzw. Dokumentation erstellt.
Um eine universelle Wiederverwendung von Glossarmodulen zu gewährleisten, ist bei der Zusammenstellung auf eine strikte Trennung von Wie (=Schritt-für-Schritt) & Was (=Hintergrundinformationen) Informationen zu achten. Dies ermöglicht die Zusammenstellung von zielgruppengerechter Dokumentation.
Nach der Herausbildung der inhaltlichen Struktur werden mit einem Transformationstool (z.B. dem DITA Open Tool Kit) automatisch Layoutinformationen hinzugefügt. Beispiele dafür sind das PDF Format, die HTML Darstellung u.a.
DITA baut auf den bewährten Erfahrungen im Bereich des Datenbank-Design, der Objektorientierten Programmierung 🇩🇪 und der Technischen Dokumentation auf. Vor der Einarbeitung in das DITA Konzept sollten Strukturierungsfähigkeiten mit hierarisch orientierten Techniken wie z.B. dem Mind Mapping Mind Map 🇩🇪 trainiert werden. DITA konforme Strukturierung erfordert einen nicht unerheblichen Einarbeitungsaufwand. DITA ist ähnlich dem ODT u.ä. Office Format ein OASIS Standard..."
Die Sissi benutzt zur weiteren allgemeinverständlichen Erläuterung das Beispiel eines Eigentumhauses. Ich wäre für ein Beispiel mit dem Firefox Browser. Wer allerdings wirklich mit DITA arbeiten will muß sich irgendwo einlesen. Das DITA Wiki sollte sich eigentlich an Leute wenden, die schon wissen wozu DITA gut ist.
Erstellt mit Hilfe von:
Sissi Closs: Single Source Publishing. Topicorientierte Strukturierung und DITA 🇩🇪
270 Seiten
Entwickler.Press Verlag
1. Auflage (1. Dez. 2006)
Ein durchdachtes Beispiel dafür bin ich noch schuldig. ☺
