Dokumentationsformate

Durch ein Hilfe-Entwicklungstool erstellte Dokumentationsformate.

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.

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?

Gewusst wie: So schreiben Sie ein hervorragendes Handbuch

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?

Die 7 besten Formate zum Veröffentlichen Ihrer Handbücher

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.

Die größten Fehler, die erstmalige Autoren von Handbüchern machen

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.

Sollte ich meine Produktdokumentation mit Microsoft Word erstellen?

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:

Warum sollten Sie ePub- und Kindle-Versionen Ihrer Hilfedateien erstellen?

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?