5 fehler, die sie beim schreiben von hilfedokumentationen vermeiden sollten

Mistakes to Avoid When Writing Help Documentation [Featured]

Wie oft schon haben Sie ewig damit zugebracht, eine Hilfedatei vergeblich nach etwas zu durchsuchen, das Ihrem Wissen nach da sein sollte? Eine Hilfedokumentation ist gewöhnlich der erste Ort, an dem wir nachsehen, wenn wir nicht wissen, wie etwas funktioniert. Wenn die Informationen in einer Hilfedatei nicht eindeutig oder, sogar noch schlimmer, irreführend sind, dann ist man letztendlich frustriert und tauscht das Produkt vielleicht sogar gegen ein anderes, leichter verständliches Produkt aus.

Das Inhaltsverzeichnis wird nicht zuerst geschrieben

Wenn Sie eine Hilfedokumentation schreiben, muss diese jeden Aspekt Ihres Produkts gründlich erklären. Es ist wichtig, dass Sie keine Funktion vergessen, über die Ihre Endbenutzer Bescheid wissen müssen. Sicherzustellen, dass alles ordnungsgemäß abgedeckt wird, gelingt am einfachsten, wenn Sie zunächst einen Plan entwerfen. Schreiben Sie zunächst das Inhaltsverzeichnis am Anfang des Dokuments und führen Sie dort jedes Thema auf, das Sie behandeln müssen. Auf diese Weise können Sie sicher sein, dass nichts ausgelassen wird.

Voraussetzen von Wissen, das der Benutzer nicht hat

Eines der Probleme vieler Hilfedokumentationen ist, dass angenommen wird, dass jeder dem Produkt mit dem gleichen Kenntnisstand begegnet. Oft ist die Dokumentation für einen speziellen Kundentyp geschrieben, wenn in Wirklichkeit viele Arten von Leuten mit verschieden ausgeprägten Kenntnissen das Produkt benutzen. Die beste Hilfedokumentation erklärt jeden Vorgang deutlich von Anfang an und verlässt sich nicht auf eventuelle Vorkenntnisse der Benutzer.

Keine Aktualisierung der Hilfedokumente

Eine Hilfedokumentation, die nicht aktualisiert wird, wenn sich das Produkt ändert, ist oft schlimmer als nutzlos. Es gibt nichts Schlimmeres als zu versuchen, eine Anweisung zu befolgen, und am Ende gesagt zu bekommen, dass man einen Button drücken soll, der nicht mehr existiert. Die Verwendung einer guten Hilfe-Entwicklungssoftware kann in dieser Situation viel Zeit sparen. Mit HelpNDoc und ähnlichen Programmen können Sie den Index Ihrer Hilfedatei einfach ändern und Abschnitte Ihres Textes umschreiben oder verschieben, ohne mit jeder Änderung das ganze Dokument umgestalten zu müssen.

Kein ordentlicher Index

Wo schaut ein Benutzer zuerst nach, wenn er ein Problem hat und Ihr Hilfedokument konsultiert? In vielen Fällen wird er das Dokument nicht von vorne bis hinten durchkämmen. Er wird mit dem Index anfangen und nachsehen, was dort zu dem Problem steht. Der Index ist in allen Hilfedokumenten ein wichtiges Werkzeug, gehen Sie sicher, dass er so vollständig wie möglich ist. Das Einfügen von Synonymen im Index ist eine hervorragende Idee: Oft gibt es mehr als ein Wort zur Beschreibung eines Themas, erleichtern Sie dem Benutzer also das Auffinden der gesuchten Informationen.

Ihre Arbeit wird durch niemand anderen geprüft oder redigiert

Auch wenn Sie denken, dass Sie die besten Hilfedokumentationen in der Welt erstellen können, lohnt es sich immer, jemand anderen den Text durchlesen und Änderungen vorschlagen zu lassen. Jeder begegnet einem Thema auf andere Weise, und es ist wahrscheinlich, dass ein frisches Paar Augen Bereiche bemerkt, die verbessert und verständlicher gemacht werden könnten.

Das Vermeiden dieser fünf häufigen Fehler wird die Qualität Ihrer Hilfedokumentationen und somit die Erfahrung Ihrer Produktbenutzer verbessern. Das Schreiben guter Hilfedokumentationen macht es wahrscheinlicher, dass die Benutzer Ihrem Produkt treu bleiben, und baut letzten Endes einen stärkeren und loyaleren Kundenstamm für Ihre Produkte auf.