Wissen >> Dokumentationsarten

Dokumentationsarten

Von der Gesamtdokumentation zur zielgruppenspezifischen Dokumentationsvielfalt

Früher war es üblich, eine Dokumentation zu verfassen, in der sämtliche Informationen über das Produkt enthalten waren. Damals musste der Leser sich mühsam die für ihn relevanten Informationen zusammensuchen. Heute orientiert sich Technische Dokumentation stärker am Bedarf der einzelnen Benutzer.

Entsprechend gibt es verschiedene Arten von Dokumentationen. Sie sind passend zu ihrem individuellen Zweck und der Zielgruppe gestaltet und haben unterschiedliche Inhalte. Denn Installateure einer Heizungsanlage brauchen beispielsweise andere Informationen als die späteren Betreiber und umgekehrt.

Vertriebsdokumentation

Unter Vertriebsdokumentation versteht man Dokumente, die ein Produkt bewerben und darstellen. Ihre Zielgruppe sind also Kaufinteressenten und Vertriebsmitarbeiter. Die Vertriebsdokumentation unterstützt den Vertrieb und kann sowohl Teil der externen als auch der internen Technische Dokumentation sein.

Beispiele hierfür können sein:

  • Datenblätter
  • Produktbeschreibungen
  • Kataloge

Installations- bzw. Montageanleitung

Mithilfe der Installations-/Montageanleitung können Handwerker oder Endkunden das Produkt wie vorgesehen in einen betriebsfähigen Zustand bringen. In dieser Dokumentation müssen zielgruppengerechte Informationen zum ordnungsgemäßen Aufstellen, die nötigen Einzelschritte für die Montage sowie Informationen zur Handhabung während der Montage zu finden sein. Dazu zählen Informationen wie diese:

  • Das richtige Werkzeug
  • Die zu beachtenden Drehmomente
  • Warnungen bei kritischen Schritten, die fehleranfällig sind

Betriebsanleitung/-handbuch

Die Betriebsanleitung richtet sich an die Nutzer eines Produkts. Diese finden hier die relevanten Informationen zu Funktion, Bedienung und Pflege sowie Handlungsanweisungen im Falle eines Fehlers. Es kann vorkommen, dass Betriebsanleitungen auch die Wartung beschreiben, falls diese durch den Nutzer ohne weiteres Fachwissen oder Spezialwerkzeug zu bewerkstelligen ist. Wenn die Wartung ausschließlich von Fachpersonal durchzuführen ist, kann hier auf eine separate Wartungsanleitung (siehe nächster Abschnitt) verwiesen werden.

Wartungsanleitung/-handbuch

Die Wartungsanleitung behandelt Inhalte, die für Monteure oder Techniker bestimmt sind. In ihr werden alle Handlungsschritte beschrieben, die zur regelmäßigen Wartung gehören. Dies umfasst sämtliche Arbeiten, die den Lebenszyklus eines Produkts verlängern, sowie die einzuhaltenden Intervalle. In der Regel sind für diese Arbeiten Fachwissen und Spezialwerkzeuge erforderlich.

Vielfältige Möglichkeiten durch Zielgruppenorientierung

Die genannten Dokumentationsarten bilden keine vollständige Liste, sondern sind nur gängige Beispiele. Durch die Zielgruppenorientierung und die sehr unterschiedliche Struktur von Unternehmen und Produkten kann es noch viele weitere Arten geben, die auf die individuellen Anforderungen des jeweiligen Szenarios zugeschnitten sind.