Anforderungen an eine Technische Dokumentation

Eine Technische Dokumentation muss es den Nutzern eines Produkts ermöglichen:

das Produkt erfolgreich montieren, installieren und in Betrieb zu nehmen
das Produkt sicher und vollumfänglich zu nutzen
das Produkt zu warten und zu reparieren, sodass dessen Funktionsfähigkeit dauerhaft erhalten bleibt
das Produkt außer Betrieb zu nehmen und zu entsorgen (erforderlichenfalls einschließlich Demontage)
das Produkt falls nötig zu transportieren

Letztlich reduzieren sich alle Anforderungen auf eine alles entscheidende Frage: Hilft die Dokumentation den Nutzern, das Produkt bestmöglich zu verwenden, oder lässt die Dokumentation die Nutzer „im Regen stehen“ und schützt sie nicht vor vermeidbaren Gefahren?

Rechtliche Anforderungen an eine Technische Dokumentation

Gesetzliche Anforderungen an eine technische Dokumentation können je nach Land und Anwendungsbereich des Produkts variieren. Beachten Sie die spezifischen Regelungen aller Länder, in denen Sie das Produkt in Verkehr bringen werden und die zu dem Zeitpunkt des Inverkehrbringens gelten.

In der Europäischen Union gibt es spezifische Anforderungen, die vor allem durch die CE-Kennzeichnung und die Produktsicherheitsrichtlinien bestimmt werden.

Informationen zu den wichtigsten Normen und Richtlinien finden Sie unter Top 10 Normen und Richtlinien zum Erstellen einer Technischen Dokumentation.

Didaktische Anforderungen an eine Technische Dokumentation

Eine gute Technische Dokumentation liefert nicht möglichst viele Informationen, sondern die richtigen Informationen. Und dies „idiotensicher“, ohne dass sich die Nutzer freilich als Idioten behandelt fühlen.

Die Herausforderungen bestehen darin:

abgestimmt auf die Nutzer des Produkts möglichst genau die benötigten Informationen zu liefern, aber auch nicht mehr Informationen
die Informationen so zu gestalten, dass sie nicht missverstanden oder fehlinterpretiert werden können
die Informationen so darzustellen, dass sie mit minimaler Anstrengung verstanden werden können und Nutzer die Bedienung des Produkts als intuitiv und einfach empfinden
die Informationen so darzustellen, dass sie in minimaler Zeit aufgenommen werden können
die Informationen so darzustellen, dass sie bestmöglich behalten werden können
die Informationen leicht zugänglich zu machen
Nutzer schnell zum Erfolg zu führen, zu motivieren, positiv zu stimmen und vom Produkt zu begeistern

Organisatorische und strukturelle Anforderungen an eine Technische Dokumentation

Die wichtigste organisatorische Anforderung an eine Technische Dokumentation ist, dass sie zeitgleich mit dem Produkt verfügbar wird. Andernfalls verzögert sich der Markteintritt nur wegen des Fehlens der Technischen Dokumentation. Eine zeitgleiche Fertigstellung ist nicht immer einfach zu bewerkstelligen, da sich viele Produkte buchstäblich bis zur letzten Minute vor Markteinführung noch ändern. Insbesondere bei Software und bei softwaregesteuerten Produkten ist das häufig der Fall. Die Technische Dokumentation muss dann diesen Änderungen zeitgleich folgen, nicht selten in mehreren Sprachen.

Wichtig ist, dass eine Technische Dokumentation möglichst modular aufgebaut ist (Baukastensystem):

Nutzern ermöglicht ein modularer Aufbau, eine Technische Dokumentation auch auszugsweise zu lesen und die einzelnen isolierten Teile trotzdem zu verstehen. (Oder kennen Sie Nutzer, die ein komplettes Handbuch von vorne bis hinten lesen?)
Ihnen als Hersteller ermöglicht eine modulare Struktur, einzelne Informationsbausteine bei Bedarf mehrfach zu verwenden – entweder an mehreren Stellen innerhalb desselben Dokuments oder in unterschiedlichen Dokumenten. Häufig gibt es zwischen verwandten Produkten große Überschneidungen. Sind die Inhalte der Technischen Dokumentation modular strukturiert, müssen Sie die identischen Inhalte nur einmal erstellen und – was noch wichtiger ist – auch nur zentral an einer Stelle pflegen und bei Bedarf übersetzen (Einsatz eines geeigneten Redaktionssystems vorausgesetzt).

Grundlage für die Erstellung der Technischen Dokumentation sollte ein Konzept sein, das die in der Technischen Dokumentation verwendeten Informationsklassen festlegt sowie deren Aufbau. Sind an der Erstellung der Dokumentation mehrere Technische Redakteure beteiligt, sorgt ein einheitliches Konzept mit einem einheitlichen Redaktionsleitfaden dafür, dass am Ende alles wie „aus einem Guss“ erscheint und sich Leser jederzeit in allen Teilen der Dokumentation gleichermaßen zurechtfinden.

Spezielle Anforderungen an Softwaredokumentation

Kaum zu glauben, aber bittere Realität: Noch immer gibt es zu vielen Software-Programmen „Handbücher“ – sei es gedruckt auf Papier oder elektronisch als PDF-Datei. Dabei geht es so viel besser. Kontextsensitive Onlinehilfen sind bereits seit dem Ende des letzten Jahrtausends Stand der Technik. Eine Onlinedokumentation kann die Nutzer wesentlich schneller und zielgenauer zu den gerade für sie relevanten Informationen führen, als ein klassisches Handbuch dies jemals kann. Das bedeutet nicht, dass es gar keine Softwarehandbücher mehr geben sollte. Mit einem geeigneten Redaktionssystem ist es durchaus möglich, ohne nennenswerten Mehraufwand aus derselben Textquelle beides zu generieren: Eine mit dem Produkt unmittelbar auf Knopfdruck am Bildschirm verfügbare Onlinedokumentation UND ein druckbares Handbuch für das Lesen längerer Passagen offline.

Organisatorisch besteht bei Softwaredokumentation eine besondere Herausforderung oft darin, dass es bei Software in der Regel häufiger Änderungen am Produkt gibt als an einem physischen Gerät (Hardware). Dementsprechend muss auch eine Softwaredokumentation typischerweise häufig aktualisiert werden. Der Erstellungs- und Publikationsprozess muss dies unterstützen.