Handbuch schreiben tipps


PRICE: FREE

INFORMATION

ISBN: 345398916
FORMAT: PDF EPUB MOBI TXT
DATEIGROSSE: 18,69

ERLAUTERUNG:

Handbuch schreiben tipps

Ein Handbuch, das oft als Nachschlagewerk dient, thematisiert Wissen zu einem bestimmten Thema in geordneter Form. Die Anordnung der Inhalte erfolgt in aller Regel nach thematischen Gesichtspunkten und vielfach chronologisch. Ein wesentliches Merkmal von Handbüchern ist deren systematische Gliederung, die meist in Form eines Inhaltsverzeichnisses als zusätzliche separate Übersicht vorhanden ist.

Monografien und Nachschlagewerke. Da Handbücher in vielen Fällen ganze Fachgebiete zum Inhalt haben, kann ein Handbuch auch in mehreren Bänden oder Teilen erscheinen, wobei es nicht selten ist, dass mehrere Herausgeber und Autoren zusammen ein Handbuch schreiben. Diese Merkmale unterscheiden ein Handbuch von anderen Nachschlagewerken, beispielsweise von Monografien. Monografien sind Fachbücher, die als umfassende, in sich vollständige Einzelschrift ein bestimmtes Sujet behandeln, etwa ein einzelnes Werk, eine besondere Problematik oder eine bestimmte Person.

Im Normalfall werden Monografien von einem Autor geschrieben, kümmern sich jedoch im Gegensatz zu Handbüchern um sehr viel engere Themengebiete. Im Unterschied zu einem Wörterbuch, das ebenfalls ein Nachschlagewerk ist, werden die Inhalte in einem Handbuch in fortlaufender Prosa dargestellt. Mischformen aus Handbuch und Wörterbuch, die die Inhalte alphabetisch angeordnet und in Prosa aufzeigen, werden als Handwörterbücher bezeichnet. Im allgemeinen Sprachgebrauch werden mittlerweile häufig auch ausführliche Gebrauchsanleitungen Handbuch oder Benutzerhandbuch genannt.

Dies erklärt sich aus der Übersetzung des englischen Wortes manual für Anleitung, ist strenggenommen jedoch nicht richtig. Handbücher im Sinne von Gebrauchsanleitungen beschränken sich auf die Benutzung des jeweiligen Gegenstandes, gehen jedoch nicht auf die Hintergründe ein und sind damit in erster Linie ein Leitfaden und eine Orientierungshilfe für die Benutzer. Durch die fehlende Darstellung des Wissensstoffes in vollständiger, chronologischer und thematischer Form erfüllen sie jedoch nicht die Anforderungen eines Handbuches im klassischen Sinne.

Gleiches gilt für die häufig als Handbücher angebotenen Leitfäden zur Lösung eines Problems oder für bestimmte Verfahren. Möchte ein Autor nun ein Handbuch schreiben, muss er dabei einige Regeln beachten. So geht es in einem Handbuch nicht nur darum, eine ausführliche Anleitung zu verfassen und diese mit praktischen Tipps zu ergänzen, sondern es müssen auch die Hintergründe dargestellt werden.

Der Leser muss durch das Handbuch ein umfassendes Nachschlagewerk erhalten, durch das er sich sowohl Hintergrundwissen aneignen als auch lernen kann, dieses Wissen zusammen mit konkreten Anleitungen und Tipps auf die Praxis zu übertragen und anzuwenden.

Neben den umfassenden Darstellungen des Themengebietes gehört hierzu auch, dass der Autor geltende Richtlinien berücksichtigt und umsetzt. Wichtig dabei ist aber, die Inhalte klar, deutlich und präzise zu formulieren und in diesem Zuge darauf zu achten, dass die Inhalte allgemein verständlich sind. Für den Aufbau eines Handbuches gilt, dass die Gliederung so einfach und übersichtlich wie möglich gestaltet werden sollte.

Eine mögliche Gliederung für ein Handbuch kann beispielsweise in zwei Teilen gestaltet werden. Im ersten Teil kann der Wissensstoff thematisch und alphabetisch geordnet dargestellt werden, im zweiten Teil kann der Autor dann Anleitungen, Arbeitsanweisungen, Checklisten oder Formblätter einfügen. Vor allem bei wissenschaftlichen Themen oder in Themenbereichen, die aufgrund von neuen Erkenntnissen oder neuen Richtlinien immer wieder Änderungen unterliegen, kann es sinnvoll sein, das Handbuch als Loseblattsammlung zu schreiben.

Dadurch wird es nämlich möglich, einzelne Blätter zu entnehmen und durch entsprechend aktualisierte Dokumente auszutauschen. Zum Inhalt springen. Inhalt 1 Handbuch schreiben 1. Über Letzte Artikel. Inhaber bei Internetmedien Ferya Gülcan.

Ob für Schule, Beruf, angehende Schriftsteller oder Redakteure, wir hoffen, dass unsere Übungen und Anleitungen Ihnen weiterhelfen. Letzte Artikel von Redaktion Alle anzeigen. Den richtigen Zeitpunkt für eine Veröffentlichung finden Was ist ein Materndienst? Einzugsermächtigung erteilen — Infos und Musterschreiben, 2. Kommentar verfassen Antwort abbrechen.

Einige davon sind essenziell, während andere diese Webseite und ihre Nutzererfahrung verbessern, wie externe Medien, Statistiken und relevante Anzeigen. OK Nein Datenschutzerklärung.

Durch das Schreiben eines hervorragenden Handbuchs erreichen Sie zwei Dinge: Sie helfen Ihren Kundengeeignete Lösungen einfach zu finden und anzuwenden, und Sie reduzieren die Kundendienstkosten Ihres Unternehmens deutlich. Aus diesem Grund kann das Schreiben eines hervorragenden Handbuchs eine der besten Investitionen Ihres Unternehmens sein. Wie können Sie ein hervorragendes Handbuch schreiben? Wie gut kennen Sie Ihre Produktbenutzer? Bevor Sie mit dem Scheiben beginnen, sollten Sie Ihre Zielgruppe definieren und deren Wortwahl und technischen Kenntnisstand recherchieren.

Wenn Sie sich an technische Experten wenden, sollten Ihre Wortwahl und Fachbegriffe anders ausfallen, als wenn Sie für unerfahrene Produktbenutzer mit wenigen oder gar keinen technischen Kenntnissen schreiben. Hervorragende Handbücher beinhalten mehrere unterschiedliche Hauptabschnitte. Diese Hauptabschnitte umfassen die Titelseiten, das Inhaltsverzeichnis, die Liste der Abbildungen und Tabellen, die Einleitung, die Kapitel, den Anhang, das Glossar, den Index und die Rückseite Eventuell sind nicht alle dieser Abschnitte für Ihr Handbuch relevant, sodass Sie die Abschnitte sorgfältig auswählen müssen, die Ihre Handbücher möglichst benutzerfreundlich machen.

Diese Hauptabschnitte sollten die Tätigkeiten in Ihrem Handbuch vereinfachen, nicht verkomplizieren. Um dies zu erreichen, sollten Sie für jeden Abschnitt ein einheitliches Format anwenden und jeden Abschnitt mit einer kurzen Zusammenfassung der auszuführenden Tätigkeit einleiten. Zunächst müssen Sie die Anleitungen oder Vorgehensweisen von den Referenzmaterialien trennen.

Dies erleichtert den Benutzern das schnelle Navigieren des Handbuchs. Jede Anweisung muss so geschrieben werden, dass sie den Benutzern hilft, bestimmte Tätigkeiten durchzuführen. Identifizieren Sie zuerst die Haupttätigkeiten, und unterteilen Sie dann jede Haupttätigkeit in Teiltätigkeiten. Beschreiben Sie eine Reihe von Schritten, die die Benutzer darüber informieren, wie jede Teiltätigkeit einfach durchzuführen ist.

Verwenden Sie dabei kurze Sätze und Wörter, die Ihre Benutzer verstehen werden. Erläutern Sie den Benutzern die Produktfunktionen und wie diese angewendet werden. Kennzeichnen Sie die Bedeutung oder Wichtigkeit durch Kontraste, Farben oder Schattierungen. Gehen Sie nicht davon aus, dass die Benutzer alle durch Sie erwähnten vereinfachten Fachbegriffe verstehen werden: Sie sollten ein Glossar der Fachbegriffe erstellen, das die Bedeutung jedes Begriffs entsprechend seiner Verwendungsweise in dem Handbuch erklärt.

Verwenden Sie die Befehlsform des relevantesten Verbs, wenn Sie die Benutzer zum Durchführen einer Tätigkeit auffordern. Das Chunking unterscheidet sich von dem Erstellen von Teiltätigkeiten. Dies gehört zu den Best Practices beim Schreiben von Hilfedokumenten und Handbüchern.

Manchmal genügen ein oder zwei Illustrationen, um den Benutzern die Durchführung einer Tätigkeit einfach verständlich zu machen. Einer der Gründe, warum einige Produktbenutzer niemals Handbücher lesen, sind die in ihnen enthaltenen langweiligen und langen Textblöcke. Durch die sachgerechte Verwendung von Abbildungen und Illustrationen zum Erklären komplizierter Tätigkeiten können Sie Ihr Handbuch leicht lesbar und verständlich machen. Es reicht ein Rechtschreibfehler oder grammatikalischer Fehler, um eine ganze Anweisung in einem Handbuch zu ruinieren.

Lesen Sie das Handbuch gründlich durchwenn Sie mit dem Schreiben fertig sind, und lassen Sie zudem mindestens zwei Personen mit fundierten Kenntnissen des Produkts das Handbuch Korrektur lesen. Wie genau wollen Sie das Handbuch veröffentlichen? Als PDF- Word- ePub-E-Book- HTML-Help-Datei oder als Hardcopy? Die Lösung ist einfach. Sie müssen solche Dokumentenformate auswählen, die den Benutzern das Handbuch leicht zugänglich machen - wenn sie es brauchen und genau so, wie sie es brauchen.

Aber was ist, wenn Ihre Benutzer Zugriff auf mehrere unterschiedliche Dokumentenformate haben? Müssen Sie sich wirklich die Mühe machen und mehrere unterschiedliche Handbücher für verschiedene Formate erstellen? Die Lösung ist ziemlich einfach: Sie können HelpNDocein Hilfe-Entwicklungstoolnutzen, das verschiedene Dokumentenformate aus einer Quelle erzeugt.

Sie müssen nur eine Datei Ihres Handbuchs erstellen, und HelpNDoc wird diese Datei dann in das Format Ihrer Wahl konvertieren. Das Schreiben eines hervorragenden Handbuchs erfordert Präzision und die Fähigkeit, auf jedes Detail zu achten. Obgleich dieser Vorgang auf den ersten Blick ziemlich langsam erscheinen mag, können Sie Hilfe-Entwicklungstools nutzen, um bessere Handbücher in der Hälfte der Zeit zu schreiben.

Direkt zum Inhalt. Gewusst wie: So schreiben Sie ein hervorragendes Handbuch. Gewusst wie: So schreiben Sie ein hervorragendes Handbuch in 8 einfachen Schritten 1. Definieren Sie, für wen Sie schreiben. Berücksichtigen Sie alle relevanten Abschnitte. Achten Sie darauf, dass der Inhalt leicht lesbar ist.

Sprechen Sie die Benutzer direkt an. Stückeln Sie Ihre Texte. Verwenden Sie Abbildungen und Illustrationen auf sachgerechte Weise. Lesen Sie Ihr Handbuch Korrektur. Wählen Sie das richtige Veröffentlichungsformat sorgfältig aus. 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 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 Tipps für das Schreiben von Online-Benutzeranleitungen.