Context Card
Sechs Modelle der Technischen Dokumentation im Vergleich
Worin unterscheiden sich topicbasierte, aufgabenorientierte, EPPO-, semantische, minimalistische und strukturierte Dokumentation?
Die kurze Antwort
Sie beantworten verschiedene Fragen, statt miteinander zu konkurrieren. Topicbasierte Dokumentation legt die Inhaltseinheit fest, aufgabenorientierte Dokumentation, welche Inhalte gebraucht werden, Every Page is Page One, ob jede Seite für sich steht, semantische Dokumentation, worum es im Inhalt geht, Minimalismus, wie Inhalte das Handeln unterstützen, und strukturiertes Schreiben, in welcher Form Inhalte entstehen. Die meisten Dokumentationssysteme kombinieren mehrere davon.
Für: Technische Redakteure, Informationsarchitekten und Leitungen von Dokumentationsabteilungen
Das Wichtigste
- Topicbasiert: Inhalte entstehen in typisierten Einheiten und werden über Maps zusammengestellt.
- Aufgabenorientiert: Inhalte werden aus einer Analyse der Nutzeraufgaben ausgewählt.
- Every Page is Page One: Jede Seite funktioniert als Einstieg für die Leserin oder den Leser.
- Semantisch: Markup und Metadaten geben an, worum es im Inhalt geht.
- Minimalismus: Inhalte unterstützen das Handeln, echte Aufgaben und das Beheben von Fehlern.
- Strukturiertes Schreiben: Inhalte folgen einem validierten Inhaltsmodell.
Der Zusammenhang
Sechs Fragen
Jedes Modell behandelt einen Aspekt der Technischen Dokumentation:
- Topicbasierte Dokumentation – wie Inhalte aufgeteilt werden: in Topics mit jeweils einem Gegenstand.
- Aufgabenorientierte Dokumentation – welche Inhalte nötig sind: die Aufgaben, die Nutzer ausführen.
- Every Page is Page One – ob jede Seite als erste gelesen werden kann, ohne die Seiten um sie herum.
- Semantische Dokumentation – worum es im Inhalt geht, ausgedrückt in Markup und Metadaten.
- Minimalismus – wie Inhalte das Handeln unterstützen, einschließlich Erkennen und Beheben von Fehlern.
- Strukturiertes Schreiben – in welcher Form Inhalte entstehen: nach einem Schema, gegen das validiert wird.
Kombiniert, nicht gewählt
Ein mit DITA erstellter Dokumentationsbestand ist in der Regel topicbasiert, aufgabenorientiert und strukturiert; mit Metadaten aus einem Informationsmodell ist er zudem semantisch. Keines der Modelle allein macht Dokumentation korrekt oder erfüllt gesetzliche Anforderungen an Gebrauchsinformationen.
Weiterlesen
Der Themenbereich Technical documentation models vergleicht die sechs Modelle in einer Tabelle; zu jedem gibt es einen eigenen Enzyklopädie-Artikel (auf Englisch).
Fragen, die sich daran anschließen
- Muss ich mich für ein Dokumentationsmodell entscheiden?
- Nein. Die Modelle wirken auf verschiedenen Ebenen und werden meist kombiniert, etwa topicbasierte, aufgabenorientierte und strukturierte Inhalte mit semantischen Metadaten.
- Ist DITA ein Dokumentationsmodell?
- DITA ist ein Standard, der mehrere Modelle zugleich umsetzt: topicbasierte Dokumentation, Informationstypen wie Task und strukturiertes Schreiben.
Quellen
- Every Page is Page One — XML Press
- Darwin Information Typing Architecture (DITA) Version 1.3 — OASIS
Prüfprotokoll und Änderungen
Jede Context Card wird vor der Veröffentlichung und bei jeder Änderung erneut anhand ihrer Quellen geprüft; das Datum unter der Autorenzeile ist die letzte Prüfung. Korrekturen (etwas war falsch) und Ergänzungen (etwas fehlte) stehen unten mit Datum und Uhrzeit (deutsche Zeit). Tippfehler, Formatierung und Link-Korrekturen werden nicht aufgeführt.
Geprüft
Seit der Veröffentlichung keine Korrekturen oder Ergänzungen.