Gedrucktes Handbuch oder Bildschirmhandbuch - Welches Format benötigen Sie?

Die Auswahl des richtigen Formats zum Veröffentlichen Ihrer Hilfedateien kann tückisch sein, besonders wenn Sie Ihr erstes Handbuch erstellen und die größten Fehler, die erstmalige Autoren von Handbüchern machen, vermeiden wollen. Das richtige Format bestimmt, ob Ihre Benutzer auf Ihre Hilfedateien genau so zugreifen können, wie sie sie brauchen und genau dann, wenn sie sie brauchen.
Wenn Sie ein Hilfe-Entwicklungstool anwenden (und das sollten Sie, denn es ermöglicht Ihnen, bessere Hilfedokumente in der Hälfte der Zeit zu schreiben), dann sollte das Veröffentlichen in mehreren Formaten gar kein Problem sein.
Die große Frage, die wir heute beantworten, lautet: Sollten Sie eine gedruckte Anleitung (Hardcopy) oder ein Bildschirmhandbuch (PDF-, CHM-, webbasiertes HTML-, E-Book-Format...) herausgeben?

Gewusst wie: So schreiben Sie ein hervorragendes Handbuch

Durch das Schreiben eines hervorragenden Handbuchs erreichen Sie zwei Dinge: Sie helfen Ihren Kunden, geeignete Lösungen einfach zu finden und anzuwenden, und Sie reduzieren die Kundendienstkosten Ihres Unternehmens deutlich.
Außerdem werden Ihre Kunden Ihr Produkt gerne empfehlen, und die Spitzenreiter in Ihrer Nische werden Ihre Marke sicher anderen Experten und deren Kunden empfehlen. Aus diesem Grund kann das Schreiben eines hervorragenden Handbuchs eine der besten Investitionen Ihres Unternehmens sein.
Wie können Sie ein hervorragendes Handbuch schreiben?

Die 7 besten Formate zum Veröffentlichen Ihrer Handbücher

Für die Auswahl des besten Formats zum Veröffentlichen von Handbüchern gibt es nur eine Regel: Wählen Sie das Format, in dem das Handbuch für Ihre Benutzer einfach zugänglich ist - wann immer sie es brauchen und gemäß ihrem Anwendungsziel.
Interessanterweise haben Produktbenutzer Zugriff auf mehrere Geräte, Softwares und digitale Inhalte, einschließlich Internetbrowsern, PDF, Microsoft Word und intelligenten Geräten wie Smartphones, Tablets, Kindle, iPads, Macs... Diese Liste ließe sich beinahe endlos fortsetzen. Aus diesem Grund kann das Schreiben eines hochwertigen Handbuchs die beste Investition Ihres Unternehmens sein.
Welches Format eignet sich am besten für das Veröffentlichen Ihres Handbuchs angesichts einer solch langen Liste? Sehen wir uns einige dieser Formate näher an.

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.

Inwiefern kann jeder durch HET-Softwareprogramme profitieren?

Viele Autoren von Handbüchern haben festgestellt, dass Hilfe-Entwicklungstools oder HET-Softwareprogramme eine gute Möglichkeit darstellen, um Handbücher und andere Hilfedokumente schnell und einfach zu schreiben. Weniger Leute machen sich jedoch Gedanken darüber, auf welche Weise die Anwendung von HET-Softwareprogrammen auch allen anderen Beteiligten Vorteile bringt, einschließlich des Herstellers, der für das Handbuch zahlt, und des Endbenutzers des Produkts.

Sollte ich meine Produktdokumentation mit Microsoft Word erstellen?

Microsoft Word ist eine tolle Software. Mit Microsoft Word können Benutzer mehr oder weniger alles schnell und einfach schreiben, von einem Schulbericht bis zu einem Geschäftsbrief. Der größte Vorteil von Microsoft Word ist der hohe Bekanntheitsgrad: Es ist eine Software, mit der die meisten von uns in der Schulzeit und im Büro aufgewachsen sind. Für viele Leute ist Microsoft Word noch immer die natürliche Wahl, wenn sie im Berufsleben etwas schreiben müssen. Und für die meisten Zwecke ist Microsoft Word ideal, es gibt jedoch einige Anwendungen, einschließlich des Schreibens von Produktdokumentationen, für die es nicht so gut geeignet ist.
Es gibt viele Gründe, warum Microsoft Word nicht das richtige Tool ist, um Ihnen beim Schreiben einer Produktdokumentation zu helfen; hier sind nur fünf dieser Gründe:

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

Hilfedokumente lassen sich jetzt einfacher schreiben

Das Schreiben eines Handbuchs ist oft ein äußerst frustrierender Prozess. Jeder ist sich im Klaren darüber, dass das Endziel die Anfertigung eines Handbuchs ist, das den Anwendern hilft, Probleme mit Ihren Produkten zu lösen und alle Produktfunktionen zu verstehen. Die Schwierigkeit liegt darin, herauszufinden, wie man dieses Ziel erreicht. Die meisten Autoren kennen das Starren auf ein leeres Blatt Papier oder den leeren Bildschirm, während man sich fragt, wie man sein neuestes Buch oder den neuen Artikel beginnen soll. Das Hauptproblem beim Schreiben von Hilfedokumenten ist zu entscheiden, wie man sich dem Thema nähern soll.

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.