10 Tipps, um gute technische Dokumentation zu erstellen

Technische Dokumentation begleitet uns regelmäßig im Alltag, wird jedoch oft nur ungern genutzt. Der Grund: Die Inhalte sind nutzerunfreundlich geschrieben oder gestaltet. Wie Sie technische Dokumentation wie Handbücher, Bedienungsanleitungen, Software- oder Produktdemonstrationen so aufbauen, dass Ihre Zielgruppe sie gern nutzt und mit ihrer Hilfe das Potenzial der technischen Produkte voll ausschöpfen kann, zeigen wir im Artikel. Lesen Sie, wie Sie eine erfolgreiche technische Dokumentation erstellen, was Sie beim Aufbau einer technischen Dokumentation beachten sollten und wie Sie mit visuellen Elementen technische Dokumentation bereichern.

Was verstehen wir unter technischer Dokumentation?

Technische Dokumentation (TD) ist ein Sammelbegriff für alle Dokumente, die ein technisches Produkt begleiten – von der Entwicklung und Produktion über die Verwendung und Instandhaltung bis hin zur Entsorgung. Der deutsche Fachverband für Technische Kommunikation und Informationsentwicklung (tekom) beschreibt die technische Dokumentation als den „Prozess der Definition, Erstellung und Bereitstellung von Informationsprodukten für die sichere, effiziente und effektive Verwendung von Produkten (technische Systeme, Software, Dienstleistungen)“.

Je nach Zielgruppe wird zwischen interner und externer technischer Dokumentation unterschieden, wobei in den meisten Fällen die Unterlagen gemeint sind, ein Hersteller nach außen gibt:

• Benutzerhandbücher
• Betriebsanleitungen
• Serviceanleitungen
• Installationshandbücher
• Softwarehandbücher
• Online-Hilfen
• usw.

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

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, um bessere technische Dokumentationen zu erstellen

Vorbereitung der technischen Dokumentation

1. Berücksichtigen Sie Ihr Publikum

Der wichtigste Grundsatz, wenn Sie technische Dokumentation erstellen, lautet: Sie schreiben für den Anwender, nicht für sich selbst. Daher müssen Sie sich im Klaren sein, an wen sich Ihre Produkt- bzw. Softwaredokumentation richtet. Wollen Sie ein Programmierhandbuch, ein Administrationshandbuch oder ein Benutzerhandbuch erstellen? Versetzen Sie sich in Ihre Leser hinein und geben Sie klare, präzise Anweisungen in deren Sprache. Ein Handbuch für Programmierer darf (und sollte) mehr Fachbegriffe enthalten als eine Benutzeranleitung, die auch für Laien verständlich sein muss.

2. Behalten Sie Ihr Ziel im Blick

Bei einem Handbuch zählt in erster Linie der Nutzen für den Anwender. Welche Kenntnisse wollen Sie vermitteln? Ein Anwender ohne Vorkenntnisse oder Training muss anhand Ihrer Anleitung das Produkt oder die Software bedienen und die von Ihnen beschriebenen Prozesse umsetzen können.

Halten Sie sich an diese Regeln, um Ihre Leser nicht unnötig zu strapazieren:

• 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 mit Autorität. Streichen Sie Wörter wie könnte, sollte, würde, eventuell usw. aus Ihrem Wortschatz. Eine Bedienungsanleitung 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 Software-Bedienungsanleitung erstellen – wenn sie keiner findet, ist sie nutzlos. Überlegen Sie sich, in welcher Form undo wo Sie Ihre Benutzerdokumentation anbieten möchten. Die Zeit der gedruckten Handbü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.

Inhalt und Aufbau der technischen Dokumentation

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 guten technischen Dokumentation sind

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

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

6. Integrieren Sie eine Suchfunktion

Die 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.

Gestaltung der technischen Dokumentation

7. Nutzen Sie visuelle Elemente

Viele Hersteller betrachten die Produktdokumentation 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 ansprechende Produkt- und Software-Bedienungsanleitungen erstellen, die als Verkaufsprospekt für Ihre Lösung dienen. Der Trick: visuelle Elemente.

Studien belegen, dass zwei Drittel (67 %) von uns Informationen besser verstehen, wenn sie visuell vermittelt werden. Komplexe Sachverhalte lassen sich über Bilder 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 in eine höhere Liga befördern.

8. Machen Sie Screenshots

Screenshots eignen sich hervorragend für die technische Dokumentation von Software, 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 Anwählen eines bestimmten Fensters oder Auswahlkästchens, 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 Screenshots mit Auszeichnungselementen ergänzen, z. B. mit:

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

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.

9. Binden Sie Videos ein

Um Vorgänge zu beschreiben – beispielsweise die Installation einer Software oder die Bedienung eines Produkts – ist Video das ideale Hilfsmittel. Gute technische Dokumentation kombiniert Textinhalte mit Screenshots und Videos und schafft so ein vielseitiges Nutzererlebnis. Bieten Sie dem Leser 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.

Sehen Sie sich diese multimediale Art der technischen Dokumentation am Beispiel unserer TechSmith Video-Tutorials verdeutlicht: an.

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 ergänzt sind.

10. Integrieren Sie Beispiele

Geben Sie Ihren Anwendern Gewissheit, dass sie Ihre Anweisungen richtig umgesetzt haben. 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 Software-Bedienungsanleitungen 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 Anleitungen und Benutzerhandbücher anwenderfreundlicher gestalten.