Willkommen beim TechSmith-Blog

Tipps, Trends und Strategien rund um die Wissensvermittlung mit visuellen Elementen und Videos

9 Tipps, um gute technische Dokumentation zu erstellen

Verbessern Sie Ihre Produkt- und Softwaredokumentation und schaffen Sie einen Mehrwert für Ihre Kunden

9 Tipps, um gute technische Dokumentation zu erstellen

Benutzeranleitungen und Handbücher gehören für die wenigsten von uns zur Wahllektüre. Leider ist die Einarbeitung in neue Systeme nicht immer intuitiv und ein Blick auf die zugehörige Software- oder Produktdokumentation unvermeidlich. Dennoch sind viele Anwender zu wenig vertraut mit manchen Produkten, um deren Potenzial richtig auszunutzen. Der Grund? Sie haben die Bedienungsanleitung zwar grob überflogen, aber nicht bis ins Detail gelesen. In diesem Artikel zeigen wir Ihnen, wie Sie gute technische Dokumentation erstellen, die Ihre Zielgruppen anspricht und ihnen einen echten Mehrwert bietet.

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 TD als den „Prozess der Definition, Erstellung und Bereitstellung von Informationsprodukten für die sichere, effiziente und effektive Verwendung von Produkten (technische Systeme, Software, Dienstleistungen)“.

Was ist technische Dokumentation? Technische Dokumentation ist der Prozess der Definition, Erstellung und Bereitstellung von Informationsprodukten für die sichere, effiziente und effektive Verwendung von Produkten.

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

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

Gute technische Dokumentation schafft Vertrauen beim Anwender und sorgt dafür, dass das Leistungsspektrum eines Produkts in vollem Maße ausgeschöpft wird. Hier geben wir Ihnen neun Tipps, um bessere technische Dokumentation zu erstellen.

Liste mit 9 Tipps für bessere technische Dokumentation.

Vorbereitung

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 der Anleitung Ihr Produkt oder Ihre 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 TD leicht auffindbar

Sie können die beste Software-Bedienungsanleitung erstellen – wenn sie keiner findet, ist sie keinen Deut besser als ein Nullachtfünfzehn-Dokument. Überlegen Sie sich, in welcher Form Sie Ihre Benutzerdokumentation bereitstellen wollen. 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 TD bei Bedarf leicht aktualisiert werden kann. Darüber hinaus sind digitale Formate für Nutzer leichter navigierbar, sodass diese die Antworten auf spezielle Fragen schneller finden. Das steigert die Kundenzufriedenheit und vermeidet unnötige Anrufe bei Ihrem Support-Team.

Aufbau und Inhalt

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

Die Gliederung Ihrer TD 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

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,
  • ein Inhaltsverzeichnis und
  • ggf. ein Stichwortverzeichnis.

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

6. Integrieren Sie eine Suchfunktion

Die digitale Produktdokumentation bietet einen großen Vorteil gegenüber gedruckten Handbüchern: die Möglichkeit, eine Suchfunktion einzubauen. Wir sind es gewöhnt, 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 TD erfüllen.

Gestaltung

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. Weniger ist mehr, doch mit ein paar anschaulichen Elementen können Sie die technische Dokumentation Ihrer Software und Produkte in eine höhere Liga befördern.

7. Nutzen 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.:

  • Positionsziffern
  • Textelementen
  • Pfeilen
  • Umrandungen
  • Callouts

Mit einem Screen Capture Tool wie Snagit geht das Erstellen und Bearbeiten von Screenshots schnell und einfach.

Ein Snagit-Screenshot zeigt Auszeichnungselemente für Screenshots zur Aufwertung der Benutzerdokumentation.

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. Binden Sie Videos mit ein

Um Vorgänge zu beschreiben – beispielsweise die Installierung 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.

Hier sehen Sie diese multimediale Art der technischen Dokumentation am Beispiel unserer TechSmith Video-Tutorials verdeutlicht:

Screenshot zur Verdeutlichung der multimedialen technischen Dokumentation am Beispiel der TechSmith Snagit Video-Tutorials.

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.

9. 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 Benutzerkommunikation 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.

Laden Sie die kostenlose Testversion von Snagit herunter und nutzen Sie die Macht der visuellen Kommunikation, um die Bindung zu Ihren Nutzern zu festigen.

Abonnieren Sie den Newsletter von TechSmith

Machen Sie es wie mehr als 200.000 andere Benutzer, die jeden Monat Tipps und Rat von Experten in ihrem Posteingang finden.

Abonnieren