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 →

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 →

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

Mehr lesen →

Die Einführung eines neuen Produkts kostet Zeit und Geld, und beides ist in jedem Unternehmen im Allgemeinen knapp. Es gibt immer Druck, die Kosten zu senken und das Produkt so schnell wie möglich fertig und verkaufsbereit zu bekommen.
Wenn man nach Möglichkeiten sucht, die Kosten auf ein Minimum zu begrenzen, kann man mitunter versucht sein zu denken, dass ein Handbuch eine zusätzliche Ausgabe ist, die so billig wie möglich hergestellt werden sollte. Es wird allgemein angenommen, dass die meisten Leute in der Lage sind, von alleine herauszufinden, wie ein Produkt zu benutzen ist, und dass sie bei Problemen jederzeit das Helpdesk anrufen können.
Dieser Denkfehler ist wahrscheinlich einer der größten Fehler, die Unternehmen heute machen. Niemand kann bestreiten, dass die Anfertigung einwandfreier Hilfedokumentationen Kosten verursacht; jedoch ausschließlich die Kosten zu berücksichtigen, ohne die durch das Handbuch entstandenen Einsparungen zu sehen, entspricht nur der halben Wahrheit.

Mehr lesen →