+49 8327 / 9319980 ahermle@hermle-consult.de

Technische Dokumentation

Unter „technischer Dokumentation“ versteht man die Summe aller Dokumente zur Beschreibung eines technischen Produktes. Dabei unterscheidet man interne und externe technische Dokumentation.

Die interne technische Dokumentation bleibt „im Haus“. Sie wird benötigt für den Herstellungsprozess und die Rückverfolgbarkeit.

Die externe technische Dokumentation geht zum Endkunden oder zum Techniker. Damit kann das Gerät in Betrieb genommen, bedient, gewartet, repariert und entsorgt werden.

Das können Sie von mir im Bereich der technischen Dokumentation erwarten

Interne technische Dokumentation

Bei der internen technischen Dokumentation kann ich Sie bei jeder Art von Dokument unterstützen.

Typischerweise wird bei der Ausformulierung und dem Sortieren von Spezifikationen ein technischer Redakteur hinzugezogen. Ebenso hat es sich bewährt, bei der Gestaltung grafischer Benutzerobeflächen einen technischen Redakteur ins Team zu holen.

Prinzipiell bin ich genau dann richtig, wenn es darum geht, eine scheinbar chaotische Menge an Information zu analysieren, zu sortieren und zu strukturieren.

Externe technische Dokumentation

Sie stellen das Rohmaterial für die externe technische Dokumentation in Form von MS Word Dokumenten, Excel Dateien, PDF Files, vorhandenen Inhalten ähnlicher Produkte, E-Mails oder Pixelgrafiken zur Verfügung.

Ich bereite dann die Information auf, entsprechend den Firmenrichtlinien, geltenden Normen und Spezifikationen.

Ich übergebe das Endprodukt an Sie in der gewünschten Form, z.B. als MS Word Dokument, PDF File oder Video. Das Video kann dabei in das PDF File eingebettet sein.

Bei Grafiken lege ich – wann immer möglich – großen Wert auf Vektorgrafiken. Diese lassen sich beliebig vergrößern und erlauben so eine höhere Informationstiefe als Pixelgrafiken.

Neben der eigentlichen Informationsaufbereitung besteht mein Schwerpunkt darin, einerseits die Inhalte effizient aufzubereiten und andererseits die Information für den Benutzer auf das Wesentliche zu reduzieren.

D.h. zu einem einfachen technischen Produkt liefere ich keine 200-seitige, umfassende Bedienungs- und Reparaturanleitung.

„Ich schreibe dir einen langen Brief, weil ich keine Zeit habe, einen kurzen zu schreiben“.

Blaise Pascal (1623 – 1662), französischer Religionsphilosoph und Naturwissenschaftler, Begründer der Wahrscheinlichkeitsrechnung

Es war also bereits im 17. Jh. bekannt, dass die Reduktion der Information auf das Wesentliche Zeit kostet. Die Kunden danken es, wenn sie keine Romane lesen müssen, um ein Gerät installieren, reparieren oder bedienen zu können. Die externe technische Dokumentation ist das, was der Kunde üblicherweise als erstes vom Produkt zu Gesicht bekommt, und ist somit ein wichtiger Bestandteil der empfundenen Qualität.

Zugleich ist es von hoher Bedeutung, einen gesunden Kompromiss zwischen Informations-Reduktionsgrad und Kosten zu finden. Bei den Erstellungskosten überwiegen üblicherweise die Basiskosten für die Informationsrecherche, Layout und normengerechte sowie firmenspezifische Aufbereitung. Was die vom Kunden empfundene Qualität dann ausmacht, ist der Informations-Reduktionsgrad. Vollständigkeit und Verständlichkeit wird stillschweigend vorausgesetzt.