In unserem Blog haben wir uns schon vielen komplexen Fragen gewidmet. Heute geht es einfach mal um das Fundament unserer täglichen Arbeit: Technische Dokumentation. Was ist das? Was gehört dazu und was nicht? Wann braucht man eigentlich eine Technische Dokumentation? Technische Dokumentationen können ganz unterschiedliche Gesichter haben, je nach zugehörigem Produkt und ausgewähltem Ausgabemedium, so viel vorweg. Hier hast du das gebündelte Wissen!

Was ist Technische Dokumentation?

Eine Technische Dokumentation ist ein Informationsprodukt, welches zu einem technischen Produkt gehört. Dieses kann greifbar sein, wie ein elektronisches Gerät oder eine mechanische Maschine bzw. große Anlage, aber auch digitale Produkte in Form einer Software umfassen.

Wichtig: Die Technische Dokumentation ist dabei als Teil des Produkts zu sehen – so sieht es auch die rechtliche Lage; ist die Technische Dokumentation mangelhaft, ist damit das Gesamtprodukt mangelhaft.

Eine Technische Dokumentation beschreibt das Produkt und dessen Anwendung bzw. Handhabung über den gesamten Produktlebenszyklus hinweg. Das heißt bei einer Maschine zum Beispiel:

  • Verpackungs- und Transporthinweise
  • Sicherheitshinweise zu allen Tätigkeiten mit dem Produkt
  • Aufstellhinweise
  • Montageanleitung
  • Erklärung der Funktionsweise
  • Informationen zur Reparatur und Wartung
  • Demontageanleitung
  • Entsorgungshinweise

„Die eine“ Technische Dokumentation ist schwer zu greifen. Eine Technische Dokumentation ist ein stark formwandelndes Wesen, also ein Metamorph. Du kannst sie als gedruckte Anleitung zu einem Produkt finden, sie kann als in ein Interface integriertes Video-Tutorial auftreten oder auch in digitalen Produkten durch den Klick auf ein kleines Fragezeichen aufpoppen.

 

Was gehört zu einer Technischen Dokumentation und was nicht?

Die Technische Dokumentation kommuniziert alle relevanten Informationen zum Produkt an die Nutzer:innen. Der Job des Technischen Redakteurs bzw. der Technischen Redakteurin ist somit die des Vermittlers bzw. der Vermittlerin von technischen Informationen, teilweise auch sehr komplexen Informationen, in die (Alltags-)Sprache der Anwender:innen. Sie machen das Produkt somit erst zugänglich.

Solche Technischen Dokus (wird gerne abgekürzt) sind keine Werbung und auch keine Presse-Mitteilungen. Die Interessent:innen sind bereits zu Käufer:innen geworden, sie müssen von der Technischen Dokumentation also nicht mehr weiter zum Kauf animiert werden. Vielmehr soll diese Lust auf die Anwendung machen und das eben nicht nur durch Werbesprüche, sondern durch gut strukturierte, verständliche Nutzungsinformationen. Dabei wird den Nutzer:innen so VIEL wie NÖTIG und gleichzeitig so WENIG wie MÖGLICH kommuniziert. Nur das, was man wirklich wissen muss, kommt in die Technische Dokumentation.

 

Was gehört also in eine solche Dokumentation? Als Antwort wäre hier eine detaillierte Liste natürlich toll. Leider ist eine abschließende Liste nicht möglich, es gibt zwar einen gemeinsamen Kern aller Arten Technischer Dokumentation, die einzelnen Kapitel variieren jedoch stark nach Produkt und Zielgruppe.

Das Herz jedes technischen Informationsprodukts, sei es eine Aufbauanleitung oder eine Online-Hilfe in einer Software, ist das schrittweise an die Hand nehmen der Nutzer:innen. Was kommt zuerst und was kommt dann – so, dass sich die Nutzer:innen begleitet fühlen. Diese Begleitung erstreckt sich über alle Produktlebensphasen, in denen sie mit dem Produkt interagieren.

Wichtig sind für unsere Nutzer:innen folgende Themen, die in jede Technische Doku gehören:

  • Sicherheitsaspekte
  • Aufbau/Installation
  • Informationen zur korrekten Handhabung
  • Informationen zum Fehlgebrauch
  • Möglichkeiten zur Fehlerbehebung oder Reparatur
  • Demontage/Deinstallation
  • Entsorgung des Produkts und ggf. seiner Verpackung

Dabei müssen nicht alle Informationen in demselben Dokument liegen. Die Gesamtdokumentation kann auch in mehrere Dokumente aufgeteilt sein z. B. neben der eigentlichen Anleitung ein extra Handbuch für die Reparatur- und Wartung für das Wartungspersonal. Auch Hinweise zum Transport können auch der eigentlichen Dokumentation ausgegliedert sein und z. B. durch Hinweise auf dem Verpackungskarton ersetzt werden.

 

Interne vs. externe Dokumentation

Denkt man an Technische Dokumentation, denkt man zunächst an Handbücher für den Endverbraucher bzw. die Endverbraucherin. Dabei kann sich die Dokumentation auch an die eigenen Mitarbeiter:innen wenden. Dann spricht man von einer internen Technischen Dokumentation. Diese können z. B. Arbeitsanweisungen formulieren oder als Schulungsgrundlagen fungieren. Auch hier geht, wie bei der externen Dokumentation, darum, den Nutzen eines Produkts zu kommunizieren und verständlich zu machen. Die Herangehensweise bei der Erstellung und die übergeordnete Fragestellung solcher Informationsprodukte ist somit gleich: Wer ist meine Zielgruppe und was muss diese wissen?

 

Wie sieht eine Technische Dokumentation aus?

Wie zuvor bereits erwähnt: „Die“ Technische Dokumentation gibt es nicht; sie kommt in verschiedenen Formen und Formaten daher. Selbst wenn man von einer gedruckten Gesamtdokumentation ausgeht, gibt es große Unterschiede. Die Anleitung zu einem Flugzeug füllt ausgedruckt ganze Regale, unterteilt in viele Kapitel in vielen Ordnern. Die Anleitung für das neues Smartphone ist hingegen ein handtellergroßes Leaflet mit viel Bild und wenig Text.

 

Bei diesen Beispielen für Haushalts/-Kleingeräten sieht man, dass Hersteller unterschiedliche Herangehensweisen gewählt haben.

Dieser Fernsehgeräthersteller hat sich für verschiedene Informationsprodukte entschieden. Es gibt einen Quick-Setup-Guide zum Entpacken des Geräts. Dieses Informationsblatt ist direkt beim Öffnen des Kartons sichtbar und gibt klar Anweisungen

  • wie das Gerät ausgepackt werden soll
  • was im Karton enthalten sein muss, also den Lieferumfang

Zusätzlich findet sich im Karton dann ein ausführliches User Manual.

Dieser Softwarehersteller bietet eine gedruckte Anleitung mit „ersten Schritten“ an, den vollen Softwareumfang kann man dann innerhalb der Software mittels Pop-Up-Hinweisen und dem Online-Handbuch erfahren.

Dieses Handbuch zu einem Kühlschrank schafft den Grad zwischen analoger und digitaler Welt. Auf dem Deckblatt der gedruckten Kurzanleitung findet sich ein Link zum Herstellerportal, wo sich die Anleitung in digitaler Form und weitere Informationen befinden.

Viele Wege führen nach Rom – und viele Wege führen zu einer guten Technischen Dokumentation. Aufbauend auf diesem Basiswissen findest du in unserem Blog viele weitere spannende Artikel rund um die Themen Technische Dokumentation und Softwaredokumentation. Lies gerne rein!