Topics: mundgerechte Info-Häppchen für die Doku
Das Aufteilen von Informationen in geschlossene Einheiten bringt viele Vorteile
Foto: Pexels/Diva Plavalaguna
Ein Topic ist eine in sich geschlossene Einheit von Informationen, die sich auf ein spezifisches Thema oder einen bestimmten Aspekt beziehen. In der Technischen Dokumentation werden Topics verwendet, um Informationen klar und strukturiert zu präsentieren und leicht zugänglich zu machen. Jedes Topic behandelt einen präzise abgegrenzten Inhalt.
Das Erstellen von Topics erfordert eine strukturierte Herangehensweise. Der Aufbau eines Topics folgt den Ideen des Funktionsdesigns®. Ein Topic setzt sich aus Sequenzmustern zusammen. Die Sequenzmuster enthalten Funktionale Einheiten in einer festgelegten Reihenfolge. Funktionale Einheiten haben einen definierten Informationsgehalt, z. B. erklären, beschreiben, auflisten, anleiten.
Klare Grenzen ziehen
Jedes Topic trägt zum Gesamtinhalt einer Dokumentation bei, ohne jedoch Informationen aus anderen Topics zu wiederholen. Wenn das Topic beispielsweise lautet „Motorölstand kontrollieren“, dann gehört der Handlungsschritt „Öffnen Sie die Motorhaube“ nicht mehr zum Topic. Er darf bestenfalls als einleitende Voraussetzung im Topic genannt werden: „Voraussetzung: Die Motorhaube ist geöffnet.“
Dennoch sollten Topics sprachlich zusammenhängen und inhaltlich gut aufeinander abgestimmt sein. Dadurch kann der Leser den Zusammenhang zwischen verschiedenen Informationen leichter verstehen. Auch die Suche nach bestimmten Informationen wird durch topicorientiertes Schreiben wesentlich erleichtert, da jeweils nur ein einziger Aspekt thematisiert wird.
Wiederverwendung fördern
Die standardisierte, einheitliche Schreibweise beim Erstellen von Topics ist die Grundlage für eine effizientere Wiederverwendung von Inhalten. Dank festgelegter Vorgaben reduziert sie die „persönliche Handschrift“ von einzelnen Verfasserinnen und Verfassern auf ein Minimum. Erst dadurch kann ein Topic in verschiedenen Dokumenten wiederverwendet werden.
Neue Nutzungsgewohnheiten
Doch nicht nur beim Wiederverwenden nach dem Single-Source-Prinzip ist der topicorientierte Ansatz wichtig. Er ist auch Voraussetzung für das Konzept „Every Page Is Page One” (EPPO). Hierunter versteht man in der Technischen Dokumentation eine alternative Herangehensweise an die Strukturierung und Bereitstellung von Informationen.
Der Grundgedanke: Jede Information soll eine geschlossene Einheit bilden und für sich allein stehen können. Im Gegensatz zum traditionellen Lesen, in dem der Inhalt linear aufgenommen werden soll, gibt es beim EPPO-Konzept nämlich keine vorgegebene Reihenfolge. Leser können von einer Seite zur nächsten springen, ohne eine bestimmte Reihenfolge einzuhalten. Die flexible Art der Navigation entspricht der Informationsaufnahme bei einer Suchmaschinenabfrage: Man gibt ein fest umrissenes Thema ein und erhält dazu passende Informationsbausteine.
Safety First
Diese Herangehensweise entspricht mehr und mehr den tatsächlichen Nutzergewohnheiten. Technische Dokumentation, vor allem für Software, präsentiert sich längst schon in digitaler Form und die selektive Suche nach bestimmten Themen ist längst Realität. Für das topicorientierte Schreiben bedeutet das: Jedes Topic sollte einen klaren Titel und möglichst auch relevante Schlagwörter haben. Aber auch die Sicherheit darf nicht zu kurz kommen. Warnhinweise, die im Kontext einer Handlung wichtig sind, müssen im Topic enthalten sein, also direkt vor oder innerhalb von Schritt-für-Schritt-Anweisungen eingebunden werden. Schließlich ist die sichere Nutzung eines Produkts nach wie vor das zentrale Anliegen von Technischer Dokumentation.
0 Kommentare: