5 erprobte Methoden, um ausgezeichnete Hilfedokumente zu erstellen

Im Zirkus ist normalerweise ein gigantisches Netz unter den Trapezkünstlern aufgespannt, das auch bei einem Fehlgriff Sicherheit bietet und den Sturz aus der Höhe auffängt. Hätten die Künstler auch ohne Netz so viel Courage? Oder würde der eine oder andere gar nicht erst ans Trapez gehen? Die Hilfedokumentation in einer Firma ist auch so eine Art Sicherheitsnetz.

Viele Anwender (und Unternehmen) beurteilen ein Produkt auch anhand der Hilfedokumentation. Wenn die Hilfe den Eindruck vermittelt, dass guter Support geliefert wird, dann beeinflusst das die Kaufentscheidung positiv. Das Gegenteil ist der Fall, wenn die Qualität der Hilfe mangelhaft ist oder völlig fehlt. Unternehmen riskieren ohne Hilfedokumentation sinkende Verkaufszahlen.

Wir haben heute einige erprobte Methoden für Sie zusammengestellt, die Ihren Support Teams helfen werden hochwertige Hilfematerialien zu erstellen und Ihre Kunden bestens zu unterstützen.

Gute Hilfe ist wie ein Sicherheitsnetz unter einem Trapez.

Wie erstellt man Hilfeunterlagen, die wirklich nützlich sind?

Ein guter Autor von Hilfetexten macht komplexe Themen einfach: Die Struktur muss so aufgebaut sein, dass die Anwender die richtigen Informationen schnell finden und leicht verstehen können.

In der Praxis bedeutet das, komplexe Konzepte in einfacher Sprache schrittweise und aufgabenorientiert zu erklären. Das ist die Grundlage guter Hilfedokumente. Wenn eine bestimmte Aufgabe viele Einzelprozesse erfordert, sollten die kleineren Teilaufgaben einzeln erklärt werden.

Zeigen Sie am Anfang jedes Themenbereichs einen groben Überblick der verschiedenen Prozessfunktionen. Der Anwender sieht dann auf den ersten Blick, wo er die Informationen findet, die er gerade braucht oder die ihn im Moment am meisten interessieren. Diese Übersicht ist auch für den Autor selbst nützlich, weil eventuelle Lücken in der aufgabenorientierten Dokumentation so schon zu Beginn aufgedeckt werden.

1. Machen Sie die Prozessabfolge eindeutig, auch wenn die Realität oft anders aussieht.

Lineare Prozesse sind leichter zu verfolgen als nicht-lineare. Die Leser der Hilfe wollen und brauchen eine klare Struktur und Führung. Zeigen Sie eine bestimmte Prozessabfolge statt in mehrere Teilaufgaben zu verzweigen.

Auch wenn technisch gesehen Funktionen A bis D in jeder beliebigen Reihenfolge ablaufen können, versuchen Sie die Funktionen in aufeinanderfolgende Aufgaben aufzuteilen. So geben Sie den Anwendern ein Beispiel für einen effizienten Workflow und klären von vornherein Fragen zur Reihenfolge und Abhängigkeit der Prozesse. Da Sie den Anwendern viele Entscheidungen abgenommen haben, werden die Lernenden die Aufgaben schneller selbst erfolgreich durchführen können.

2. Wählen Sie anwenderorientierte Begriffe

Drücken Sie sich klar und präzise aus und schreiben Sie in einem aktiven Stil. Benutzen Sie Worte und Formulierungen, nach denen die Anwender suchen, und nicht extrem technische Begriffe, die Entwickler vielleicht benutzen würden.

Sie sollten Ihr Publikum kennen. Wenn Sie Daten haben, die Ihnen helfen, die Produkteinstellung Ihrer Zielgruppen zu verstehen, dann nutzen Sie diese Erkenntnisse, um genau die richtigen Formulierungen zu verwenden.

Auch wenn Ihr Produkt sehr komplex und technisch ist, muss die Hilfe nicht so sein. Gliedern Sie die Hilfe in überschaubare Abschnitte und erklären Sie alles in leicht verständlicher Weise. Nutzen Sie Umgangssprache und einen kontrollierten Wortschatz und einfache grammatikalische Strukturen. Die Anwender werden das zu schätzen wissen.

Sehr gute Empfehlungen zu Inhalt, Organisation und Sprachstil in technischen Dokumenten finden Sie in diesem Artikel der Freien Universität Berlin.

3. Optimierung für Suchmaschinen

Beim Suchen nach Hilfeinformationen im Internet oder in der Produkthilfe sollten auch die passenden Hilfeartikel erscheinen.

Wenn Ihre Anwender auf Google nach Antworten suchen, müssen Ihre Hilfeartikel dort auch zu finden sein. Falls auf einer internen Hilfe-Website gesucht wird, muss der richtige Artikel ganz oben in den Suchresultaten angezeigt werden. Das bedeutet, dass Sie genau wissen müssen, wie die verschiedenen Suchmaschinen Seiten katalogisieren und bewerten. Schreiben Sie Ihre Hilfeartikel im Hinblick auf diese Kriterien.

Es gibt gute Methoden, Ihre Inhalte (ob PDF oder Webseite) für Suchmaschinen zu optimieren.

4. Verlinkung zu verwandten Artikeln und Ressourcen

Wenn es zu einem Thema weitere relevante Supportartikel, Blog-Posts oder Tutorials gibt, sollten Sie diese unbedingt auf Ihrer Seite oder in Ihrem Dokument verlinken.

Diese anderen Ressourcen beschreiben das Thema oft in leicht abgewandelter Weise oder geben noch mehr technische Details und weiterführende Informationen. Das kann sehr hilfreich für die Anwender sein.

5. Visuelle Medien zur Illustration Ihrer Texte

Im letzten Punkt sollten wir visuelle Medien ansprechen, auch wenn es noch eine Menge weiterer Diskussionspunkte zur Erstellung von guten Hilfematerialien gibt. Bilder und Videos können Hilfeartikel sehr viel besser machen. Schlecht ausgewählte Illustrationen bewirken allerdings das Gegenteil. Ich empfehle die Integration visueller Dokumente in Hilfedokumentation dann, wenn die Bilder und Videos den Textinhalt verdeutlichen und veranschaulichen.

Denken Sie daran, dass auch die visuellen Medien – Bilder, Videos oder animierte GIFs – konsistent und einheitlich gestaltet werden sollten. Format und Stil sollten den unternehmensinternen Branding-Richtlinien entsprechen. So werden die Inhalte gut überschaubar, leicht zu organisieren und einfach zu verstehen. Visuelle Elemente sollen Informationen verdeutlichen und nicht noch mehr Fragen aufwerfen.

Sind Sie Supportmitarbeiter, Content Marketer oder arbeiten Sie in einem anderen Bereich? Diese Tipps sollten Ihnen helfen, Hilfeinhalte zu produzieren, die Ihre Anwender zum Erfolg führen.

Auch dieser Artikel zur Erstellung illustrierter Anleitungen mit Snagit könnte Sie interessieren.