Tipps & Tricks

Rat, Vorschläge und Ideen zur Entwicklung und Verbesserung des Schreibens und der Anfertigung von Hilfedateien und Handbüchern.

Die größten Fehler, die erstmalige Autoren von Handbüchern machen

Was ist der schlimmste Fehler, den Sie als erstmaliger Autor eines Handbuchs machen können?

Eine gutes Handbuch ist benutzerfreundlich und enthält klare Anweisungen, die die Benutzer problemlos finden und nutzen können. Das Erstellen eines guten Handbuchs kann jedoch eine schwierige Aufgabe sein, wenn Sie zum ersten Mal ein Handbuch verfassen und besonders wenn es sich um Ihr erstes technisches Schreibprojekt handelt.
Interessanterweise hat jeder gute Autor von Handbüchern einmal klein angefangen und etliche Fehler bei seinem ersten Versuch gemacht. Wir haben diese Fehler für Sie zusammengestellt, damit Sie Ihnen nicht auch passieren. Glücklicherweise können Sie aus diesen Fehlern lernen und so ein erstklassiges Handbuch bei Ihrem ersten Versuch erstellen.

Hilfedokumente müssen nicht langweilig sein

Seien wir ehrlich: Hilfedokumente haben heutzutage ein fürchterliches Image. Nahezu jeder, mit dem man spricht, hat einen schlechten Eindruck von Handbüchern. Dafür gibt es viele verschiedene Gründe, einige der häufigsten sind:

  • Es beantwortet einem nicht die Frage, die man hat.
  • Man kann die Antwort nicht finden, obwohl man weiß, dass sie irgendwo drin steht.
  • Das Handbuch lässt sich schwer navigieren.
  • Die Dokumentation ist nicht mehr aktuell.
  • Die Dokumentation existiert noch nicht.

Wenn Hilfe und Handbücher schiefgehen

Im Zusammenhang mit Hilfedokumenten kennt fast jeder mindestens eine Horrorgeschichte. Entweder geht es um den Versuch, ein Produkt zu verstehen, wenn das Handbuch in solch einem schlechten Deutsch geschrieben wurde, dass es unverständlich ist, oder um ein Produkt, das mit einem Handbuch für ein völlig falsches Modell geliefert wurde. Oder vielleicht handelt die Geschichte von einem dieser Handbücher, die so voller Details gepackt sind, dass sie zu viele Informationen enthalten und es fast unmöglich wird, die Antwort, die man schnell braucht, zu finden. Es gibt viele Möglichkeiten für das Misslingen von Handbüchern, aber im Allgemeinen können diese meistens in zwei hauptsächliche Bereiche unterteilt werden...

Best Practice beim Schreiben von Hilfedokumenten und Handbüchern

Das Schreiben von Hilfedokumentationen kann ein komplizierter Prozess sein. Sie müssen lernen, wie ein Produktanwender zu denken, nicht wie ein Entwickler. Als die für das Schreiben der Hilfedokumentation verantwortliche Person haben Sie sich wahrscheinlich eine Weile lang mit Ihrem Produkt auseinandergesetzt und sind mittlerweile sehr vertraut mit seiner Funktionsweise. Dies ist nützlich für das Schreiben von Hilfedokumentationen, kann jedoch zugleich von Nachteil sein, da Sie anders an das Produkt herangehen als jemand, der es zum ersten Mal betrachtet. Was für Sie offensichtlich sein mag ist eventuell ein komplettes Rätsel für jemanden ohne Ihre Erfahrung mit dem Produkt oder Ihre Kenntnis des Konstruktionsprozesses.

Warum das Schreiben eines hochwertigen Handbuchs die möglicherweise beste Investition für Ihr Unternehmen ist

Die Einführung eines neuen Produkts kostet Zeit und Geld, und beides ist in jedem Unternehmen im Allgemeinen knapp. Es gibt immer Druck, die Kosten zu senken und das Produkt so schnell wie möglich fertig und verkaufsbereit zu bekommen.
Wenn man nach Möglichkeiten sucht, die Kosten auf ein Minimum zu begrenzen, kann man mitunter versucht sein zu denken, dass ein Handbuch eine zusätzliche Ausgabe ist, die so billig wie möglich hergestellt werden sollte. Es wird allgemein angenommen, dass die meisten Leute in der Lage sind, von alleine herauszufinden, wie ein Produkt zu benutzen ist, und dass sie bei Problemen jederzeit das Helpdesk anrufen können.
Dieser Denkfehler ist wahrscheinlich einer der größten Fehler, die Unternehmen heute machen. Niemand kann bestreiten, dass die Anfertigung einwandfreier Hilfedokumentationen Kosten verursacht; jedoch ausschließlich die Kosten zu berücksichtigen, ohne die durch das Handbuch entstandenen Einsparungen zu sehen, entspricht nur der halben Wahrheit.

Schreiben Sie bessere Hilfedokumente in der Hälfte der Zeit

Das Schreiben von Hilfedokumentationen kann ein sehr langwieriger Prozess sein. Wenn Sie ein kompliziertes Produkt erklären müssen, ist es nicht ungewöhnlich, dass die Hilfedokumentation mehrere hundert Seiten umfasst, und auch ein ziemlich einfaches Produkt braucht mitunter ein Handbuch mit 50 oder 100 Themen.
Und Hilfedokumente sind nicht nur aufgrund ihrer Länge schwierig zu schreiben. Wenn Ihr Handbuch für Ihre Leser nützlich sein soll, müssen Sie sicherstellen, dass jede Funktion des Produkts in der Dokumentation enthalten ist und dass jeder Aspekt des Produkts genau und auf eine Ihren Endbenutzern hilfreiche Weise beschrieben wird.
Bei so vielen zu berücksichtigenden Informationen können das Strukturieren und die rechtzeitige Fertigstellung Ihre Hilfedokumentation eine ernsthafte Herausforderung für jeden technischen Redakteur darstellen. Glücklicherweise gibt es einen Weg, um Hilfedokumente schneller zu schreiben, alles einzufügen, was Sie abdecken müssen, und dennoch ein qualitativ hochwertiges, professionelles Dokument zu erstellen, das in mehreren Formaten herausgegeben werden kann.

Warum sollten Sie ePub- und Kindle-Versionen Ihrer Hilfedateien erstellen?

Jeder versteht die Wichtigkeit genauer und aktueller Hilfedokumentationen. Die Betriebsanleitung zu lesen und herauszufinden, wie man jede Funktion richtig anwendet, ist der einzige Weg, um das Beste aus einem Produkt herauszuholen. Die Schwierigkeit, vor der die Entwickler vieler Produkte stehen, ist die Formate auszuwählen, in denen die Hilfedokumentationen hergestellt werden sollen. Früher galt ein gedrucktes Handbuch für die meisten Produkte als ausreichend. Seit einigen Jahren wird das gedruckte Handbuch häufig durch entweder eine PDF- oder Online-Version ersetzt, sind diese jedoch die wirklich besten verfügbaren Optionen?

Die idiotensichere Anleitung zum Schreiben von Hilfedokumenten und Handbüchern

Wenn Sie noch nie eine Hilfedokumentation geschrieben haben, dann kann diese Aufgabe ein bisschen unheimlich erscheinen. Die Endanwender Ihres Produkts verlassen sich darauf, dass Sie ihnen helfen, jede Funktion des Produkts zu verstehen, und ihre kontinuierliche Benutzung des Produkts hängt davon ab, wie erfolgreich Ihre Antworten zu ihren Fragen sind. Hier ist unsere „idiotensichere Anleitung” zum Schreiben von Handbüchern und Hilfedokumenten. Diese Tipps werden Ihnen helfen, Hilfedokumente zu schreiben, die alle zu berücksichtigenden Details abdecken und für Ihre Endanwender leicht verständlich sind.

Benutzen Sie ein Hilfe-Entwicklungstool und reduzieren Sie Ihre Kosten für Kundenbetreuung

Was sind die für Ihr Unternehmen bedeutendsten produktbezogenen Kosten? Jeder weiß, dass das Erstellen eines neuen Produkts Geld kostet. Es entstehen Kosten durch die Entwicklung, Prüfung und Herstellung des Produkts sowie dadurch, das Produkt an die Kunden zu bringen. Dies alles ist notwendig, wenn man ein Produkt erstellen will, das sich verkaufen lässt und zu Einnahmen führt, die das Unternehmen wirtschaftlich vorankommen lassen.

5 fehler, die sie beim schreiben von hilfedokumentationen vermeiden sollten

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.