10 Tipps für gute Technische Dokumentation

Technische Dokumentation begleitet uns regelmäßig im Alltag, wird jedoch nur dann gern genutzt, wenn die Inhalte nutzerfreundlich geschrieben und gestaltet sind. Technische Dokumentation kann viele Formen annehmen, wie Bedienungsanleitungen, Benutzerhandbücher oder Softwaredokumentation. Wir haben uns angeschaut, wie Sie Ihre Technische Dokumentation so erstellen, dass Ihre Zielgruppe sie gern nutzt und mit ihrer Hilfe das Potenzial der dokumentierten Produkte voll ausschöpfen kann. Lesen Sie im Artikel unsere 10 wichtigsten Tipps, was Sie beim Aufbau und Schreiben einer Technischen Dokumentation beachten sollten und wie Sie mit visuellen Elementen Technische Dokumentation bereichern und komplementieren.

Was verstehen wir unter Technischer Dokumentation?

Technische Dokumentation (TD) ist ein Sammelbegriff für alle Dokumente, die ein Produkt begleiten – von der Entwicklung und Produktion über die Verwendung und Instandhaltung bis hin zur Entsorgung. Auf Wikipedia finden wir folgende Beschreibung für Technische Dokumentation: “Eine Technische Dokumentation (auch Technische Kommunikation, Technikdokumentation oder Produktdokumentation) umfasst alle Informationsprodukte, die ein technisches Erzeugnis beschreiben und zu seiner Nutzung, Wartung oder Reparatur anleiten. Sie bereitet die Informationen systematisch auf und strukturiert sie so, dass der jeweilige Zweck vollständig erfüllt wird.”

Im deutschsprachigen Raum ist die Gesellschaft für Technische Kommunikation e. V. (tekom) maßgeblich an der Weiterentwicklung von Standards, Best Practices und Qualitätskriterien von Technischer Dokumentation beteiligt.

Je nach Zielgruppe kann zwischen interner und externer Technischer Dokumentation unterschieden werden. Externe Technische Dokumentation meint in den meisten Fällen die Dokumente, die ein Produkthersteller nach außen gibt. Dazu zählen z. B.

Auch Montageanleitungen gehören zur Technischen Dokumentation – hier ein Beispiel, das allen IKEA-Kunden nur allzu geläufig sein dürfte:

Bei dieser Montageanleitung für ein IKEA-Regal sind die Instruktionen auch ohne Text dank Diagrammen und Bildern klar und leicht verständlich. ©Ikea

Gute Technische Dokumentation schafft Vertrauen beim Anwender und sorgt dafür, dass das Leistungsspektrum eines Produkts in vollem Maße ausgeschöpft werden kann. Hier geben wir Ihnen zehn Tipps für eine hochwertige Technische Dokumentationen:

1. Berücksichtigen Sie Ihre Zielgruppe

Bei Technischer Dokumentation zählt in erster Linie der Nutzen für den Anwender. Der wichtigste Grundsatz, wenn Sie Technische Dokumentation erstellen, lautet daher: Sie schreiben für den Anwender, nicht für sich selbst. Sie müssen sich also im Klaren sein, an wen sich Ihre Technische Dokumentation richtet und wer Ihre Zielgruppe ist. Versetzen Sie sich in Ihre potentiellen Leser hinein. Ein Handbuch für Softwareprogrammierer darf mehr Fachbegriffe enthalten als eine Bedienungsanleitung für einen Heimdrucker, die auch für Laien verständlich sein muss. Bei einem Benutzerhandbuch sollte auch ein Anwender ohne Vorkenntnisse oder Training anhand Ihrer Technischen Dokumentation das Produkt bedienen und die von Ihnen beschriebenen Prozesse umsetzen können.

2. Geben Sie klare, präzise Anweisungen

Nutzen Sie eine Sprache, die Ihre Zielgruppe versteht und halten Sie sich an diese Regeln, um Ihren Lesern die Nutzung Ihrer Technischen Dokumentation so einfach wie möglich zu machen:

  • Schreiben Sie keinen Roman. Wählen Sie kurze Sätze und achten Sie darauf, dass jedes Wort relevant ist. Streichen Sie alles, was keine zusätzlichen Informationen beinhaltet.
  • Schreiben Sie eindeutig und mit Autorität. Streichen Sie Wörter wie könnte, sollte, würde, eventuell usw. aus Ihrem Wortschatz. Eine Produktdokumentation lässt keinen Spielraum für Interpretationen.
  • Seien Sie direkt. Ihr Ziel ist es, dem Anwender so schnell wie möglich alle nötigen Informationen an die Hand zu geben. Auch wenn Sie dafür fünfmal hintereinander schreiben müssen: „Klicken Sie…“.

3. Machen Sie Ihre Technische Dokumentation leicht auffindbar

Sie können die beste Produktdokumentation erstellen – wenn sie keiner findet, ist sie nutzlos. Überlegen Sie sich, in welcher Form und wo Sie Ihre Technische Dokumentation anbieten möchten. Die Zeit der gedruckten Benutzerhandbücher ist weitgehend vorbei. Stattdessen setzen moderne Unternehmen auf Online-Plattformen, um Kunden die Technische Dokumentation zu einer Software oder einem Produkt bereitzustellen.

Ein großer Vorteil hierbei ist, dass die Technische Dokumentation bei Bedarf leicht aktualisiert und ausgetauscht werden kann. Darüber hinaus sind digitale Formate für Nutzer leichter navigierbar und durchsuchbar, sodass sie Antworten auf spezielle Fragen schneller finden. Das steigert die Kundenzufriedenheit und vermeidet unnötige Anrufe bei Ihrem Support-Team.

Achten Sie bei der digitalen Bereitstellung Ihrer Technischen Dokumentation auch auf die Keyword-Optimierung: Recherchieren Sie wichtige Suchbegriffe Ihrer Nutzer und stellen Sie sicher, dass Ihre Technische Dokumentation für diese Suchbegriffe weit oben rankt und sofort auffindbar ist.

4. Wählen Sie aussagekräftige Titel und Untertitel

Die Gliederung Ihrer Technischen Dokumentation ist ein wichtiger Orientierungspunkt für den Nutzer. Titel und Untertitel helfen Lesern, sich zurechtzufinden und relevante Themen schneller zu identifizieren. Wählen Sie deshalb aussagekräftige, konkrete Überschriften, die jeweils ein eng gefasstes Thema behandeln. Fragesätze eignen sich besonders gut, weil sie die Gedankengänge des Anwenders simulieren.

Arbeiten Sie sich nach dem Zwiebelschalenprinzip vor: Zunächst geben Sie einen groben Überblick über ein Thema, um anschließend in den Unterkapiteln tiefer in die einzelnen Komponenten einzutauchen. Details müssen sich nahtlos in das bisher Gelernte einfügen, um den Leser nicht zu verwirren. Achten Sie darauf, dass jeder Schritt für den Leser klar nachvollziehbar ist.

5. Achten Sie auf eine übersichtliche Präsentation

Technische Dokumentation wie Benutzerhandbücher sind Nachschlagewerke und sollten deshalb so gestaltet sein, dass es leicht ist, die nötigen Informationen auf Anhieb zu finden. Charakteristische Elemente einer gut gestalteten Technischen Dokumentation sind:

  • Inhaltsverzeichnis
  • ggf. Stichwortverzeichnis
  • Titel und Untertitel
  • Listen
  • Infokästen
  • Zusammenfassungen

Eine übersichtliche Präsentation springt Anwendern ins Auge und steigert die Chancen, dass Ihre Technische Dokumentation tatsächlich gelesen wird.

6. Nutzen Sie visuelle Elemente

Viele Hersteller betrachten die Technische Dokumentation als ein notwendiges Übel und behandeln sie entsprechend stiefmütterlich. Das Ergebnis sind langweilige, textlastige Dokumente, die im besten Falle überflogen und in vielen Fällen komplett ignoriert werden.

Dabei können Sie mit geringem Aufwand eine ansprechende Produktdokumentation erstellen, die gleichzeitig für Marketingzwecke eingesetzt werden kann. Der Trick: visuelle Elemente. Studien belegen, dass zwei Drittel von uns Informationen besser verstehen, wenn sie visuell vermittelt werden. Komplexe Sachverhalte lassen sich über Bilder und Screenshots besser erklären. Das bedeutet nicht, dass Sie einen Grafikdesigner anheuern müssen, um Ihre Technische Dokumentation zu erstellen. Doch mit ein paar anschaulichen Elementen können Sie die Technische Dokumentation Ihrer Software und Produkte perfektionieren.

Visuelle Elemente machen Ihre Technische Dokumentation vollständig

Mit Snagit können Sie Abläufe schnell bildlich erfassen und mit Erklärungen versehen. So erstellen Sie im Handumdrehen leicht verständliche technische Anleitungen.

Kostenlose Testversion herunterladen
Snagit icon

7. Machen Sie Screenshots

Screenshots eignen sich hervorragend für die Technische Dokumentation von Software und Informationstechnologie, da sie die Benutzeroberfläche 1:1 abbilden. Das hilft dem Leser, sich auf der Bildschirmseite zu orientieren und versichert ihm, dass er sich auf dem richtigen Weg befindet.

Gute Screenshots simulieren einen Ist-Zustand der Benutzeroberfläche, um Handlungsanweisungen zu verdeutlichen. Das erfordert etwas Vorbereitung, z. B. durch Definieren eines bestimmten Fensters oder Auswahlbereichs, Eingabe eines Beispielwerts etc. Wenn ein Screenshot sehr viele Informationen enthält oder Sie das Auge des Betrachters auf wesentliche Elemente lenken möchten, können Sie Teile des Screenshots ausschneiden (Snippets) oder Ihre Screenshots in vereinfachte Grafiken (Simplified User Interfaces) umwandeln.

Noch deutlicher wird Ihr Inhalt, wenn Sie Ihre Bildschirmaufnahmen aufbereiten und Auszeichnungselemente ergänzen, z. B.:

  • Positionsziffern
  • Textelementen
  • Pfeilen
  • Umrandungen 
  • Callouts
  • Aufzählungen und Nummerierungen

Screenshots einfach erstellen und bearbeiten

Mit Snagit fertigen Sie Bildschirmaufnahmen schnell und unkompliziert an. Ihre Screenshots bearbeiten Sie anschließend im Snagit Editor. Einfach, leistungsstark und effektiv.

Kostenlose Testversion herunterladen
Snagit icon

TIPP: Wenn Sie Ihre Produkt- oder Softwaredokumentation in verschiedenen Sprachen erstellen, müssen Sie bei der Lokalisierung darauf achten, auch die Screenshots in der Zielsprache zu erzeugen, damit der Text-Bild-Bezug erhalten bleibt.

8. Bieten Sie Videos an

Um Vorgänge zu beschreiben – beispielsweise die Installation oder Bedienung einer Software – ist Video das ideale Hilfsmittel. Gute Technische Dokumentation kombiniert Textinhalte mit Screenshots und Videos und schafft so ein vielseitiges Nutzererlebnis. Bieten Sie dem Nutzer eine Schritt-für-Schritt-Anleitung und ein begleitendes Video, in dem diese in die Praxis umgesetzt wird. Das Video verdeutlicht den Prozess und die schriftliche Anleitung dient als Gedächtnisstütze.

Auch wir bei TechSmith nutzen für unsere Technische Dokumentation Tutorials, die diese Elemente sinnvoll und nutzerfreundlich kombinieren: Schritt-für-Schritt-Anleitungen in Textform werden mit aufbereiteten Screenshots und kurzen Videotutorials kombiniert. Hier ein Beispiel:

Screenshot von einem Snagit-Tutorial zur Funktion Bildschirm erfassen.

Ganz oben auf der Seite bietet ein Video einen allgemeinen Überblick, und darunter stehen ausführliche Anleitungen zu den wichtigsten Funktionen, die zur Veranschaulichung mit Snippets, Screenshots und animierten GIFs bereichert werden.

9. Integrieren Sie eine Suchfunktion

Digitale Technische Dokumentation bietet einen großen Vorteil gegenüber gedruckten Handbüchern: die Möglichkeit, eine Suchfunktion einzubauen. Wir sind es gewohnt, Fragen und Stichwörter in ein Suchfeld einzugeben und mit einem Klick die gewünschten Antworten zu finden. Ihre Nutzer werden es Ihnen danken, wenn Sie diese Erwartung auch im Rahmen Ihrer Technischen Dokumentation erfüllen.

10. Geben Sie Beispiele

Geben Sie Ihren Anwendern Gewissheit, dass sie Ihre Anweisungen richtig umsetzen. Hierfür können Sie Ihrer Technischen Dokumentation zum Beispiel einen Screenshot hinzufügen, der zeigt, wie das Resultat einer bestimmten Handlung aussehen soll.

Auch an anderer Stelle hilft es Lesern, wenn Sie die Anweisungen in Ihrer Technischen Dokumentation mit Beispielen illustrieren. Screenshots erstellen ist eine Sache von wenigen Sekunden – nutzen Sie sie, um bessere Anleitungen zu erstellen!

Werten Sie Ihre technische Dokumentation auf 

Klare, übersichtliche und leicht nachvollziehbare Anweisungen sind das A und O einer guten Technischen Dokumentation. Steigern Sie Ihre Kundenzufriedenheit, indem Sie Produktdokumentation für Ihre Anwender optimieren und so gestalten, dass sie gern genutzt wird. So sichern Sie sich auch langfristig treue Kunden und unternehmerischen Erfolg.

Nutzen Sie die Macht der visuellen Kommunikation

Erstellen Sie technische Dokumentation, die Ihren Kunden wirklich nützt. Mit Snagit erzeugen und bearbeiten Sie hilfreiche Screenshots und Bildschirmvideos und stärken Ihre Kundenbindung.

Kostenlose Testversion herunterladen
Snagit icon

TechSmith

TechSmith ist der führende Anbieter von Software für die Bildschirmaufnahme und Produktivitätslösungen für die Kommunikation im Arbeitsalltag – sei es im Büro, unterwegs oder im Homeoffice – sowie für Bild- und Videoinhalte, die sich an Kundinnen und Kunden richten. Mit unseren preisgekrönten Flaggschiffprodukten, Snagit, Camtasia und Audiate, können auch Ungeübte beeindruckende Videos und Bilder erstellen und so ihr Wissen auf effektive Weise vermitteln – für bessere Schulungen, Tutorials und die alltägliche Kommunikation.

Abonnieren Sie den Newsletter von TechSmith

Der TechSmith Newsletter hat bereits über 200.000 Abonnenten. Melden auch Sie sich an und erhalten Sie Monat für Monat praktische Tipps und professionelle Ratschläge.

Abonnieren