Topics: eine Frage, eine Antwort

(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)

Ein Anwender greift dann zur Technischen Dokumentation, wenn er eine Frage auf eine Antwort sucht, zum Beispiel dann, wenn er eine bestimmte Aufgabe ausführen will oder den Wert eines bestimmten Parameters sucht. Die Informationsstruktur, die diesem Informationsbedürfnis am besten entgegenkommt, ist das Topic.

Mit einem Topic wird eine in sich abgeschlossene Informationseinheit definiert. Konkret ist ein Topic durch folgende Eigenschaften charakterisiert:

  • Ein Topic beantwortet vollständig eine Frage.
  • Ein Topic steht für sich allein.
  • Auf ein Topic kann einzeln zugegriffen werden.

Weiterführende Inhalte werden in weiteren Topics zur Verfügung gestellt. Die Verbindung der Topics untereinander wird über eine Referenzierung hergestellt. In der Online-Dokumentation und in PDF-Dateien sind diese Referenzierungen über Links realisiert.

Topics können Medien wie Text, Bilder, Videos, Flash-Animation usw. enthalten. Der Einsatz der Medien hat immer in der Weise zu erfolgen, dass mit ihnen tatsächlich nur die Antwort auf die im Topic gestellte Frage gegeben wird.

In DITA wird eine Typisierung von Topics vorgenommen, das heißt, es wird festgelegt, welche Art von Inhalten in den verschiedenen Topictypen erfasst werden. Jedem Topictyp in DITA liegt eine andere Klasse von Fragestellungen zugrunde, was sich entsprechend auf die Inhalte der einzelnen Topictypen auswirkt. Diese Herangehensweise ist nicht neu und beispielsweise aus dem Information Mapping™ bekannt. Eine Typisierung ist keine notwendige Eigenschaft, die ein Topic aufweisen muss. Ein Topic kann auch erstellt werden, ohne dass dabei eine Typisierung berücksichtigt werden muss. Die Typisierung der Topics in DITA dient ebenso wie beim Information Mapping™ dazu, den Technischen Redakteur dabei zu unterstützen, die Inhalte für ein Topic zu erstellen.

Topics werden häufig zuerst in Verbindung mit Online-Dokumentation gebracht. Hier wurde die Bedeutung von Topics schon frühzeitig erkannt, zum einen deshalb, weil der Nutzer nicht gern am Bildschirm liest und weil dort große Textmengen verpönt sind, und zum anderen, weil für Online-Dokumentationen häufig nur kleine Bildschirme zur Verfügung stehen, auf denen umfangreiche Texte nur ungenügend Platz finden. Kurze und knappe Topics, die schnell die gewünschte Antwort auf eine Frage liefern, sind daher für das Medium Bildschirm wie geschaffen.

Das hinter Topics liegende Prinzip, nämlich dass eine in sich abgeschlossene Informationseinheit die Antwort auf eine Frage liefern soll, kann ebenso gut auf die Print-Dokumentation angewendet werden. Hier allerdings lässt man sich häufig dazu verleiten, die beinah endlos zur Verfügung stehende Papiermenge als Anlass dafür zu nehmen, die dargebotene Informationsmenge überproportional zu erhöhen. Allein dass das Medium Papier zur Verfügung steht, also ein Medium, bei dem sehr große Textmengen sehr gut lesbar angeboten werden können, scheint die Annahme zu verstärken, dass der Nutzer auch mehr lesen will. Topics beantworten auch in der Print-Dokumentation eine Frage – jedoch nur wesentlich ausführlicher. Somit wird topicorientiertes Schreiben zwar oftmals für die Print-Dokumentation propagiert, aber dafür weniger konsequent praktiziert als bei Online-Hilfen.

Auch bei der Entwicklung von DITA ist zu beobachten, dass die strikte Verwendung von Topics gerade in Bezug auf die Print-Dokumentation gelockert wurde. Während noch in DITA Version 1.0 quasi die reine Lehre von Topics proklamiert wurde, steht mit der DITA Version 1.1 ein printonly-Attribut zur Verfügung, mit dem Inhalte in Topics gekennzeichnet werden können, die nur für die Print-Dokumentation gültig sind. Wie in der Architekturspezifikation von DITA Version 1.1 ausdrücklich hingewiesen wird, dient das printonly-Attribut als eine Art Hilfskonstruktion, um einen Übergangstext, wie er in der Print-Dokumentation häufig zu finden ist, in Topics packen zu können.

So scheint es bei einem Topic also nicht nur darauf anzukommen, dass auf eine Frage eine Antwort geliefert wird, sondern auch, in welchem Medium die Frage gestellt und die Antwort gegeben wird. So zumindest suggeriert es bei DITA das printonly-Attribut. Allerdings kann das printonly-Attribut auch als Produkt des bei der Textproduktion immer noch vorherrschenden Buchparadigmas angesehen werden, nämlich dass Texte in Büchern linear und nicht topicorientiert zu organisieren sind. Damit verbunden ist auch die Vorstellung, dass auf Papier mehr geschrieben werden muss, was zu der Annahme führt, dass von Papier auch gerne mehr gelesen werden würde. Somit kann das printonly-Attributt eher als Zugeständnis für die Technischen Redakteure als für die Nutzer der Technischen Dokumentation angesehen werden.

  

<< zurück vor >>

 

 

 

Tipp der data2type-Redaktion:
Zum Thema DITA bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

Copyright © 2008 XLcontent Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DITA - Der neue Standard für Technische Dokumentation" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

XLcontent Verlag, Pflegerstraße 40, 81247 München