Was ist technische Dokumentation?

Technische Dokumentation Definition

Es gibt Berufe, die relativ unbekannt sind und unter deren Berufsbezeichnung sich Außenstehende nicht sehr viel vorstellen können. Zu diesen Berufen gehört bisher der des Technische Redakteurs. Entsprechend bekommt man als Technischer Redakteur gelegentlich die Frage gestellt, was man in diesem Beruf eigentlich tut. Artikel für Technikzeitschriften verfassen? Kann vorkommen, das Berufsfeld ist weit. Viele Technische Redakteure kürzen das Raten ab und bringen „den Klassiker“ ins Spiel: Gebrauchsanleitungen. Nicht nur, aber vor allem Gebrauchsanleitungen schreibt man als Technischer Redakteur.

Definition "technische Dokumentation"

Etwas weiter gefasst erstellen Technische Redakteure technische Dokumentation. Aber was ist darunter zu verstehen? Die Norm VDI 4500 Blatt 1 bietet eine Definition:

„Technische Dokumentation beinhaltet alle Informationen, die von einem Hersteller/Vertreiber parallel zum Entstehen und zum Lebensweg eines Produktes (Produktlebenszyklus) erstellt werden.“

Diese Definition bringt auf den Punkt, dass technische Dokumentation quasi alle Dokumente umfasst, die im Laufe eines Produktlebens beim Hersteller des Produkts entstehen: von den ersten Entwicklungsplänen, über interne Protokolle und Anweisungen, über die Gebrauchsanleitung bis zur Außerbetriebnahme- und Entsorgungsanleitung.

Die technische Dokumentation ist damit zwar sehr weit gefasst. Welche Informationsprodukte aber tatsächlich erstellt werden müssen und ob der Technische Redakteur damit betraut ist, ist natürlich je nach Unternehmen sehr unterschiedlich.

Um etwas übersichtlicher darzustellen, was typischerweise unter technischer Dokumentation verstanden wird, bietet sich die Unterscheidung zwischen interner und externer technischer Dokumentation an: Interne technische Dokumentation „beinhaltet alle technischen Informationen über ein Produkt, die im Unternehmen verbleiben“ (VDI 4500 2006, 4). Risikobeurteilungen, Prüfprotokolle und dergleichen gehören also zur internen technischen Dokumentation. Externe technische Dokumentation „beinhaltet alle technischen Informationen über Produkte, die […] für […] Anwender und Verbraucher bestimmt sind“ (VDI 4500 2006, 6). Unter anderem die Gebrauchsanleitung ist somit Gegenstand der externen technischen Dokumentation.

Technische Dokumentation im Produktlebenszyklus

Die folgende Abbildung zeigt einen typischen Produktlebenszyklus nach ISO 9004:

Technische Dokumentation im Produktlebenszyklus nach ISO 9004

Während der einzelnen Phasen bzw. für die einzelnen Phasen des Produktlebenszyklus können zum Beispiel folgende Informationsprodukte entstehen:

Phasenbezeichnung Informationsprodukte
Produktbeobachtung Service-Bulletin (Dokumentation einzelner Supportfälle)
Produktspezifikation Informationskonzept
Produktentwicklung Entwicklungsdokumentation, Schaltpläne, Hydraulikpläne
Verifizierung Freigabedokumente
Verpackung und Lagerung Lagerungshinweise
Verkauf Produktkataloge und -webseiten
Verteilung Transportanleitung
Montage Montageanleitung
Inbetriebnahme Inbetriebnahmeanleitung
Betrieb Gebrauchsanleitungen, Betriebsanleitungen, Softwarehilfen, Support-Webseiten
Technische Unterstützung Ersatzteilkataloge
Wartung Wartungsplan, Hilfsstofflisten
Beseitigung (oder Wiederverwendung) Deinstallationsanleitung
Marketing Vertriebsunterlage

Wozu professionelle technische Dokumentation?

Technische Dokumentation

Kaum ein Unternehmen verkauft mehr Produkte, weil die zugehörige technische Dokumentation gut gemacht ist. Weshalb also sollten Unternehmen in professionelle technische Dokumentation investieren? Es gibt einige Argumente dafür, sich über technische Dokumentation ernsthaft Gedanken zu machen:

das Unternehmen rechtlich absichern

Für die meisten Unternehmen ist das wichtigste Argument eine möglichst weitgehende Absicherung vor Schadenersatzansprüchen. Voraussetzung dafür ist, dass die Nutzer befähigt werden, ein Produkt gefahrlos zu verwenden. Sollte dennoch ein Nutzer mit einem Produkt einmal einen Unfall erleiden, dann kann der Produkthersteller im Idealfall auf seine technische Dokumentation verweisen und darauf, dass der Unfall bei Befolgen der Informationen vermeidbar gewesen wäre. Ausführlichere Informationen hierzu auf der Seite „Gesetzliche Grundlagen der technischen Dokumentation“.

die Benutzer befähigen, das Produkt fehlerfrei zu verwenden

Ein ebenfalls wichtiges Argument ist die Verringerung der Anzahl von Supportanfragen, Reklamationen und Garantiefällen. Solche Vorfälle verursachen oft hohe Kosten und verärgern die Kunden. Durch professionell erstellte technische Dokumentation können viele Fehlbedienungen oder ähnliche Probleme von vornherein vermieden werden: Die Anwender erhalten alle nötigen Informationen an der richtigen Stelle und in leicht nachvollziehbarer Weise. Sollten doch einmal Schwierigkeiten auftreten, finden die Anwender zum Beispiel in der Gebrauchsanleitung schnell Hilfe. Die Support-Experten haben dadurch mehr Zeit für wirklich wichtige Kundenprobleme.

die Benutzer befähigen, den Funktionsumfang des Produkts auszunutzen

Mit dem technischen Fortschritt werden viele Produkte immer komplexer und damit erklärungsbedürftiger. Ohne die entsprechenden Erklärungen können Anwender nur einen Teil der Funktionen nutzen, die eigentlich verfügbar sind. Das kann dazu führen, dass Anwender insgesamt mit dem Produkt unzufrieden sind, auch wenn keine Fehlbedienungen vorliegen.

Viele Funktionen erschließen sich schlichtweg nicht allen Anwendern von selbst. Ist es nicht schade, wenn dadurch Funktionen ungenutzt bleiben, die sogar ein Alleinstellungsmerkmal eines Herstellers sind? Ein Beispiel hierfür sind viele moderne Smartphones: Mitgeliefert wird oft nur noch eine Schnellstartanleitung für die nötigsten Funktionen, zum Beispiel um das Gerät ein- oder auszuschalten oder die SIM-Karte einzulegen. Die Entdeckung aller weiteren Funktionen obliegt dem Spieltrieb des Anwenders.

technische Dokumentation als Marketinginstrument

Einige Unternehmen haben erkannt, dass technische Dokumentation auch Teil einer Markenstrategie sein kann. Kunden, die sich auch nach dem Kauf optimal mit Informationen versorgt fühlen, erleben die Marke positiver. Die Wahrscheinlichkeit steigt, dass Kunden wiederholt ein Produkt dieser Marke kaufen.

Schulung und Vertrieb unterstützen

Die zielgruppengerecht aufbereiteten Informationen der Technischen Redakteure sind oft für weitere Abteilungen in einem Unternehmen sehr nützlich, zum Beispiel für Schulungen oder für den Vertrieb.

Kosten einsparen

Bei der Erstellung der technischen Dokumentation können natürlich auch Kosten eingespart werden, wenn professionell vorgegangen wird. Zentrale Schlagworte sind hier „Wiederverwendung“ und „Automatisierung“.

Mit Hilfe von …

  • Modularisierung,
  • Trennung von Inhalt und Layout,
  • konsistentem und zielgruppengerechtem Inhalt
  • und konsistenten Inhaltsstrukturen

… können Inhalte mit relativ geringem Aufwand mehrfach verwendet werden. Das ist beispielsweise dann sinnvoll, wenn ein Produkt in unterschiedlichen Varianten angeboten wird. Es können dann teils dramatische Einsparungen bei der Erstellung der technischen Dokumentation in der Ausgangssprache und beim Übersetzen erzielt werden.

Kosten können zusätzlich eingespart werden durch eine insgesamt bessere, reibungslosere Unternehmenskommunikation.

neuartige technische Möglichkeiten

Last but not least eröffnen sich dank moderner technischer Dokumentation ganz neue Möglichkeiten, wie Informationen bereitgestellt werden können. Denken Sie beispielsweise an Apps für Smartphone oder Tablet, an Augmented Reality, an Content Delivery Portale und vieles mehr.

Was macht ein Technischer Redakteur?

Dieser Artikel ist ein Auszug aus dem kostenfreien E-Book "Grundlagen der technischen Dokumentation - Motivationen, Methoden und Zusammenhänge".