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?

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.

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.

Wenn Sie jemals versucht haben, irgendeine Art von Dokumentation zu schreiben, dann wissen Sie, dass dieser Prozess nicht so einfach ist, wie man vielleicht denkt. Das Verfassen qualitativ hochwertiger Hilfedokumente oder Handbücher erfordert viel Zeit und eine Menge Planung, um sicherzustellen, dass alle Funktionen des Produkts richtig erklärt werden. Viele technische Redakteure werden bereits von Hilfe-Entwicklungstools gehört haben, und einige haben vielleicht sogar überlegt, sie auszuprobieren, waren sich jedoch nicht ganz im Klaren darüber, was die Vorteile der Verwendung eines Hilfe-Entwicklungstools im Vergleich zu einem normalen Textverarbeitungsprogramm sind. Hier sind drei Methoden, mit denen ein Hilfe-Entwicklungstool Ihnen helfen kann, bessere Hilfedokumentationen zu schreiben.

Kurz gesagt: HETs sind durch Software entwickelte Hilfe-Entwicklungsprogramme, die von technischen Redakteuren zur Ausarbeitung von Hilfedokumenten und technischen Handbüchern und Lösungsbeschreibungen angewendet werden.

Nehmen Sie zum Beispiel irgendein Produkt auf dem heutigen hart umkämpften Verbrauchermarkt — sei es ein Auto, ein Haushaltsgerät, eine Computersoftware oder irgendein Produkttyp, der eine Betriebsanweisung oder eine Funktionsdurchführung oder Montage durch den Verbraucher erfordert — und Sie werden im Regelfall eine allzu leicht vergessene „Hinter-den-Kulissen-Initiative” von engagierten Fachleuten entdecken, die zum erfolgreichen Werdegang und Verkauf dieses Produkts geführt hat.

Deshalb ist der Satz von Benutzerhilfedokumentationen, der typischerweise das Produkt begleitet, nie leichtfertig zu betrachten; er hat das letztendliche Ziel, die Nutzungs- und Funktionserfahrung des Käufers zu maximieren und die Support-Kosten des Produzenten zu senken. Klare und effektive Benutzeranweisungen machen häufig den entscheidenden Unterschied hinsichtlich Kundenwertschätzung, -treue und -akzeptanz aus und können so zum Erfolg oder Scheitern eines Produkts führen.

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.

Die Erstellung von Hilfedokumentationen für Produkte hat viele Ähnlichkeiten mit einer typischen studentischen Projektarbeit. Eine studentische Projektarbeit muss oft:

• Ein Thema in der Tiefe diskutieren und jeden Aspekt des Themas gründlich behandeln
• Ein Thema in deutlich identifizierbare Abschnitte unterteilen
• Detaillierte Verweise einfügen, die das Fazit der Projektarbeit unterstützen
• Ein das diskutierte Thema vollständig abdeckendes Inhaltsverzeichnis erstellen

Eine Hilfe-Entwicklungssoftware ist zur Handhabung all dieser Aufgaben viel besser geeignet als ein konventionelles Textverarbeitungsprogramm. Wenn Sie eine studentische Projektarbeit in Microsoft Word schreiben, bleibt Ihnen kaum etwas anderes übrig, als am Anfang des Themas anzufangen und das ganze Ding der Länge nach einzutippen. Dieser Ansatz macht das Schreiben von Projektarbeiten knifflig und äußerst zeitaufwendig.

Das Verfassen von Hilfedokumentationen bedeutet harte Arbeit; ein technischer Redakteur muss jede Funktion eines Produkts auf verständliche Weise beschreiben. Die Dokumentation muss für eine große Bandbreite an Produktanwendern mit unterschiedlich ausgeprägter technischer Fachkenntnis oder verschiedenen Erwartungen geschrieben werden.
Trotz dieser Voraussetzung finden viele technische Redakteure, dass das Schreiben der Hilfedokumentation der einfache Teil des Prozesses ist. Nachdem sie alles aufgeschrieben haben, was notwendig ist, um das Thema ordentlich abzudecken, müssen sie die Dokumentation so formatieren, dass sie in einer Vielzahl an Formaten zugänglich und einfach lesbar ist. Eventuell erforderliche Formate umfassen PDF, Word, Online-HTML, vielleicht HLP oder auch CHM. Der ganze Formatierungsprozess kann sehr zeitaufwendig sein, vor allem da die meisten technischen Redakteure sich darauf konzentrieren wollen, wirklich gute Hilfedokumentationen zu schreiben, anstatt sich ewig darum zu kümmern, wie ihre Seiten auf verschiedenen Geräten angezeigt werden.
Wenn die Dokumentation schließlich fertig ist, bedeutet das häufig noch immer nicht das Ende des Prozesses, denn jedes Mal, wenn das Produkt abgeändert wird, muss die Dokumentation revidiert werden, um die neuen oder aktualisierten Funktionen widerzuspiegeln.