Tipps & Tricks

Rat, Vorschläge und Ideen zur Entwicklung und Verbesserung des Schreibens und der Anfertigung von Hilfedateien und Handbüchern.

So erstellen Sie eine attraktive Online-Dokumentation

Man könnte meinen, dass der Inhalt der einzige Aspekt ist, der die Benutzer bei der Anwendung einer Dokumentation interessiert. Eine solche Annahme ist jedoch weit von der Wirklichkeit entfernt. Das Design ist eines der wichtigsten Aspekte jeder Online-Dokumentation. Eine optisch ansprechende Dokumentation wie beispielsweise ein Benutzerhandbuch, das relevante Abbildungen und eingebettete Videos sowie an das Website-Design angepasste Schriftarten und Themen enthält, ist grundsätzlich visuell attraktiver und benutzerfreundlicher!
Hier geben wir Ihnen 5 einfache Tipps für die Erstellung optisch ansprechender und benutzerfreundlicher Online-Dokumentationen.

Vorteile der Suchmaschinenoptimierung Ihrer Online-Hilfen und Online-Handbücher

Weltweit sind Millionen von Internetnutzern ständig auf der Suche nach Antworten und Lösungen mittels Internetsuchmaschinen. Google allein verarbeitet weltweit täglich 3,5 Milliarden Suchanfragen und 1,2 Billionen Suchanfragen pro Jahr. Diese beeindruckenden Zahlen haben etliche Unternehmen und Betriebe dazu bewegt, jetzt alles daran zu setzen, ihre Inhalte suchmaschinengerecht zu machen.
Was ist jedoch mit technischen Inhalten wie Hilfetexten und Dokumentationen? Sollten Unternehmen und technische Redakteure ihre Online-Hilfesysteme an Server senden, die von Suchmaschinen durchsucht und indexiert werden können? Und wenn ja, bringt dies Vorteile gegenüber anderen Unternehmen und Redakteuren, die dies nicht tun? Finden wir es heraus.

Tipps für das Schreiben von Online-Benutzeranleitungen

Online-Benutzeranleitungen und -Handbücher sind eine äußerst praktische Option, da auf sie einfach und von fast überall aus zugegriffen werden kann. Online-Benutzeranleitungen und -Handbücher müssen jedoch zweckmäßig verfasst werden, um effektiv und benutzerfreundlich zu sein.

Im Gegensatz zu gedruckten Benutzeranleitungen und Handbüchern werden Online-Handbücher oft durch mobile Geräte wie Smartphones und Tablets abgerufen. Auch wenn ihre Nutzung nicht auf diese Geräte beschränkt ist, erfahren Sie hier mehr über die besten Formate zum Veröffentlichen Ihrer Hilfedateien.
Was sollten Sie also beim Schreiben von Online-Benutzeranleitungen und -Handbüchern berücksichtigen? In diesem Artikel möchten wir Ihnen 6 grundlegende Tipps vorstellen.

6 Grundsätze für das technische Schreiben, die Ihre Dokumentationen benutzerfreundlicher machen

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.

Das Schreiben von Software-Dokumentationen für Endbenutzer: So gelingt es Ihnen

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!

7 wichtige Gründe, warum Sie eine responsive HTML-Website brauchen

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.

So erstellen Sie benutzerfreundliche Dokumentationen mit Simplified Technical English

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.

Warum Benutzer Ihre Handbücher nicht lesen und wie Sie das ändern können

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?

5 wesentliche Qualifikationen, die Sie brauchen, um ein hervorragender technischer Redakteur zu werden

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.

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?