Die englische Sprache ist eine der am weitesten verbreiteten Sprachen im technischen Schreiben. Die englische Sprache ist jedoch kompliziert - reich an Idiomen, Verbalphrasen, Redewendungen, Synonymen, mehrdeutigen Wörtern und Begriffen, die bei Nichtmuttersprachlern und sogar Muttersprachlern für Verwirrung sorgen können. Dies ist einer der Hauptgründe, warum einige Benutzer Handbücher nicht lesen.
Beim Erstellen einer Dokumentation ringt wohl jeder technische Redakteur mit der schwierigen Aufgabe, komplexe technische Begriffe in sehr einfachen und leicht verständlichen Worten, Sätzen und Anweisungen zu vermitteln. In den meisten Fällen wird die Leistung des technischen Redakteurs anhand des Benutzer-Feedbacks gemessen.
Um technische Dokumentationen wie beispielsweise Benutzerhandbücher, Hilfedateien, Sicherheitsleitfäden etc. verständlicher und benutzerfreundlich zu machen, hat die Aerospace and Defence Industries Association of Europe (ASD) das Simplified Technical English (STE) entwickelt, das auch als ASD-STE100 oder als die Thumbs-up-Technik bekannt ist.

Mehr lesen →

Die Wirksamkeit jeder technischen Dokumentation hängt davon ab, wie gut der technische Redakteur ihren Inhalt für das Zielpublikum angepasst und attraktiv gemacht hat. Jedoch ist das zielgruppengerechte Zuschneiden des Inhalts in vielen Fällen nicht die hauptsächliche Herausforderung.
Die größte Herausforderung liegt in der richtigen Identifizierung und Analyse des Publikums. So ist es nicht ungewöhnlich, wenn technische Redakteure fragen: “Wie kann man seinen Inhalt für ein bestimmtes Zielpublikum anpassen und attraktiv machen, wenn man es noch nicht einmal kennt?” Diese Frage ist einer der Gründe dafür, warum Benutzer Ihre Handbücher nicht lesen.
Die Analyse des Zielpublikums ist vielleicht der wichtigste Aspekt des technischen Schreibens. Wenn Sie sie richtig durchführen, wird Ihr Kundendienstteam erleichtert aufatmen und werden sich Ihre Kundendienstkonsten drastisch reduzieren.
Was passiert jedoch, wenn Sie keinen Volltreffer landen? Sie werden mehr für Ihren Kundendienst ausgeben müssen. Vielleicht ein neues Handbuch erstellen müssen, und Sie können sich vorstellen, welchen Schaden Ihr Produktname als Marke dadurch nehmen kann, vor allem, wenn Ihre Konkurrenten alles richtig machen. Nun, Sie können ein solches Szenario einfach vermeiden, indem Sie Ihr Zielpublikum analysieren.

Mehr lesen →

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?

Mehr lesen →

Was ist der Unterschied zwischen einem hervorragenden technischen Redakteur und einem hervorragenden Schriftsteller?
Beide sind hervorragende Autoren. Aber nur einer von beiden beherrscht die Schlüsselqualifikationen, die erforderlich sind, um nahezu jedem unabhängig von seinem oder ihrem technischen Know-how die Benutzung nahezu jedes Produkts, das technische Kenntnisse voraussetzt, verständlich zu machen.
Wenn Sie ein technischer Redakteur sind oder vielleicht Interesse an diesem Beruf haben, dann ist es auch für Sie wichtig, die erforderlichen Qualifikationen zu beherrschen. Um Ihnen das technische Schreiben zu vereinfachen, haben wir 5 der wichtigsten Qualifikationen zusammengestellt, die jeder professionelle technische Redakteur beherrschen sollte.

Mehr lesen →

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?

Mehr lesen →

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?

Mehr lesen →

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 →

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.

Mehr lesen →

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.

Mehr lesen →

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.

Mehr lesen →