people text - Technische Dokumentation. Verständlich. Schnell. Professionell. Technische Dokumentation. Verständlich. Schnell. Professionell.

Link-Konzept erstellen

Links sind ein wesentlicher Bestandteil jeder Technischen Dokumentation. Sie erleichtern den Benutzern das Navigieren innerhalb des Dokuments und führen sie schneller zu der gesuchten Information. Schon bei der Planung einer Technischen Dokumentation gilt es, ein systematisches Link-Konzept zu erstellen – andernfalls kann der Nutzen von Links ins Gegenteil umschlagen.

Auch für die Redakteure ist ein durchdachtes Link-Konzept eine Arbeitserleichterung. Insbesondere bei vielen Informationsklassen kann die Verlinkung sonst zu Unübersichtlichkeiten führen.

Voraussetzungen für ein Link-Konzept

Bevor ein Link-Konzept erstellt werden kann, müssen die Hierarchien und Relationen zwischen den Informationsklassen definiert sein. Das bedeutet, dass alle vorgesehenen Texte entsprechenden Informationsklassen zugeordnet wurden, beispielsweise Schrittanleitung, Funktionsbeschreibung oder Sicherheitshinweis. Diese Informationsklassen werden in eine hierarchische Struktur gebracht, um Ordnung und einen konsistenten Aufbau zu gewährleisten. Welche Informationsklassen bauen zwingend aufeinander auf, welche Relationen sind erlaubt oder verboten? Diese Vorarbeiten sollten bereits bei Einführung eines Redaktionssystems oder beim Aufsetzen der Technischen Dokumentation in einfachen Textverarbeitungsprogrammen erledigt sein.

Link-Konzept entwickeln

Auf das Informationsklassen-Konzept folgt die Erstellung des Link-Konzepts: Zwischen welchen Informationsklassen sind Links vorgeschrieben, erlaubt oder verboten. Dabei muss das Link-Konzept nicht unbedingt das Informationsklassen-Konzept spiegeln. Vielmehr ist ein Link auch möglich zwischen Informationsklassen, die entsprechend dem Informationsklassenkonzept nicht auf einander folgen dürfen. Beispiel für einen obligatorischen Link: Verweis von einer umfangreichen Funktionsbeschreibung auf eine Schrittanleitung.

 

Infografik: Link-Konzept. Die Pfeile in Orange verdeutlichen die Hierarchie zwischen den Informationsklassen. Die blauen Pfeile zeigen die Link-Konvention, die insgesamt das Link-Konzept ergibt.

 

Links können auch ein hilfreiches Mittel sein, um lange und unübersichtliche Dokumente besser zu strukturieren. So lassen sich umfangreiche Dokumente in mehrere kleine Dokumente aufteilen, die miteinander verlinkt sind. Diese Verwendungsart ist eine praktische Hilfe, um die Inhalte nach einheitlichen Regeln zu gestalten.

Darüber hinaus sollte das Link-Konzept auch Layout und Usability-Fragen berücksichtigen, beispielsweise sollten die Links sich immer deutlich vom übrigen Text abheben, damit Benutzer sie deutlich erkennen können. Dazu gehört es unter Umständen auch, verschiedene Ausgabeformate zu berücksichtigen, z.B. Dokumentation für mobile Endgeräte.
Schließlich sollte das Link-Konzept qualitätssichernde redaktionelle Prozesse vorsehen.

Vorteile eines Link-Konzepts

Selbst wenn kein komplexes Informationsklassensystem für die Dokumentation notwendig ist, sollte trotzdem ein Link-Konzept erstellt und im Redaktionsleitfaden verankert werden. Nur mit einem Link-Konzept werden verschiedene Dokumente sinnvoll und konsistent verlinkt. So trägt ein Link-Konzept dazu bei, dass Benutzer nicht nur schnell und einfach das finden, wonach sie suchen, sondern dass ihnen auch noch sinnvolle Zusatzinformationen angeboten werden.

Insgesamt ist also schon bei der Planung einer Technischen Dokumentation zu berücksichtigen, dass Links im Rahmen eines durchdachten Link-Konzepts eingesetzt werden und eine hinreichende Qualitätssicherung erfolgt. Nur so lässt sich gewährleisten, dass Links ihre Funktion innerhalb der Dokumentation erfüllen und ein größtmögliches Maß an Benutzerfreundlichkeit bieten.

Redaktionsleitfaden
Richtig ans Ziel