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.

Mehr lesen →

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:

• Das Handbuch ist veraltet oder enthält die falschen Informationen.
• Das Handbuch ist schlecht geschrieben oder schwer zu navigieren.

Mehr lesen →

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.

Mehr lesen →

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.

Mehr lesen →

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?

Mehr lesen →

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.

Mehr lesen →