Topicbasierte Dokumentation gliedert Inhalte in einzelne, thematisch abgegrenzte Einheiten, die sogenannten Topics. Ein Topic behandelt beispielsweise einen Begriff, eine Aufgabe oder eine Funktion. Es soll so verständlich und eigenständig formuliert sein, dass es auch ausserhalb seiner ursprünglichen Position verwendet werden kann [7].
Dieser Ansatz unterstützt eine strukturierte Dokumentation: Inhalte werden nach ihrer Funktion und ihren Beziehungen geordnet. Grundlagen erklären Zusammenhänge, Anleitungen beschreiben Handlungen und Referenzinformationen enthalten Angaben zum Nachschlagen. Ein einheitlicher Aufbau dieser Inhaltstypen erleichtert die Orientierung und die Wiederverwendung.
Ein Topic besitzt einen Titel und eine eindeutige Kennung, über die es referenziert werden kann. Für eine Publikation werden die Topics ausgewählt und in einer übergeordneten Struktur angeordnet, die beispielsweise als Inhaltsverzeichnis sichtbar wird. Querverweise verbinden zusammengehörige Inhalte.
Neben vollständigen Topics lassen sich auch kleinere Inhaltsbausteine wiederverwenden, beispielsweise wiederkehrende Hinweise oder gemeinsame Definitionen. Solche Bausteine werden in manchen Autorentools als Snippets bezeichnet. Veränderliche Angaben wie Produktnamen oder Versionsnummern können zentral hinterlegt und über Platzhalter eingebunden werden. Bedingungen steuern, welche Inhalte in einer bestimmten Ausgabe enthalten sind.
Diese Möglichkeiten werden je nach Autorensystem unterschiedlich umgesetzt. DITA stellt ein standardisiertes Modell für topicbasierte Inhalte bereit, andere Systeme verwenden eigene Inhaltsmodelle [7]. Die Aufteilung in Topics allein gewährleistet jedoch noch keine verständliche Dokumentation. Entscheidend sind eine sinnvolle Abgrenzung der Themen, einheitliche Bezeichnungen und nachvollziehbare Verknüpfungen.
Abbildung 4: Wiederverwendung von Topics.
Quelle: KI-gestützte Eigendarstellung.
Topics werden typischerweise unabhängig von der späteren Dokumenthierarchie abgelegt. Ihre Reihenfolge und hierarchische Zuordnung werden im Autorensystem festgelegt. So lassen sich dieselben Topics zu unterschiedlich strukturierten Dokumentationen zusammenstellen.
BeiHelp+Manual liegen die Topicdateien beispielsweise gemeinsam in einem Ordner.
Abbildung 5: Topicdateien im Ordner.
Quelle: Eigener Screenshot.
Die Struktur der fertigen Dokumentation entsteht im Help+Manual-Editor über das Inhaltsverzeichnis (Table of Contents, TOC), in dem die Topics angeordnet und einander untergeordnet werden.
Abbildung 6: Topicdateien in TOC angeordnet.
Quelle: Eigener Screenshot.
