Hilfe-Entwicklungstools

Eine benutzerfreundliche Dokumentation ist für jeden technischen Redakteur eine gelungene Dokumentation. Das Schreiben einer solchen kann jedoch schwierig sein, vor allem wenn man für ein breites Publikum schreibt, das diverse Länder und Sprachen umfasst. Hier stellen wir Ihnen effektive Grundsätze für das technische Schreiben vor, die Ihnen beim Schreiben benutzerfreundlicher Hilfematerialien als Orientierungshilfe dienen können.

Eine effektive Software-Dokumentation hilft den Endbenutzern, die mit der Software arbeiten, die Funktionen der Software und die Durchführung bestimmter Aufgaben zu verstehen. Technischen Redakteuren stellt sich die Frage, wie man dieses Ziel erreichen kann, wenn man für Endbenutzer mit nur geringem oder nicht vorhandenem technischen Wissen schreibt. Hier finden Sie es heraus!

Möchten Sie, dass Ihre Website toll aussieht und eine beeindruckende und reichhaltigere Benutzererfahrung über alle Geräte, Plattformen und Bildschirmgrößen hinweg bietet?
Aufgrund der heutigen Nutzung von Smartphones und Tablets liegt der Schluss nahe, dass Sie eine solche Website brauchen. Sie sollten jedoch über die aktuellen Geräte hinausschauen und zukünftige Geräte wie Smartwatches, Google Glass, Virtual- und Augmented-Reality oder andere mögliche neue Geräte, die die Technologieexperten auf uns loslassen, berücksichtigen. Responsive Websites und eine responsive Entwicklung werden auch für diese funktionieren. Schauen wir uns also an, wie wichtig responsive HTML-Websites sind.

Sie haben ein nahezu perfektes Produkt entwickelt oder eine großartige Software erstellt. Und um Nutzungsprobleme zu lösen, haben Sie dann einige der besten technischen Redakteure damit beauftragt, ein benutzerfreundliches Handbuch zu schreiben. Sie wollen, dass Ihre Produktbenutzer von der ersten Minute an Freude an Ihrem Produkt haben. Wie Ihr User-Experience-Team bestätigt hat, haben die technischen Redakteure eine tolle Arbeit geleistet.
Aber nach der Markteinführung Ihres Produkts oder der Veröffentlichung eines Updates scheinen Sie deutlich mehr für die Kundenbetreuung auszugeben. In vielen Fällen sind die Antworten, die Ihre Benutzer suchen, direkt in dem Handbuch zu finden. Sodass Sie sich jetzt dieselbe Frage stellen, die sich bereits viele Hersteller und Entwickler gefragt haben: Lesen die Produktbenutzer die Handbücher überhaupt?

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?

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.

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.

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.

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:

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