Handbuch schreiben anleitung


PRICE: FREE

INFORMATION

ISBN: 209339508
FORMAT: PDF EPUB MOBI TXT
DATEIGROSSE: 17,75

ERLAUTERUNG:

Handbuch schreiben anleitung

An diesem Artikel arbeiteten freiwillige Autoren daran, ihn im Laufe der Zeit zu bearbeiten und zu verbessern. Dieser Artikel wurde Bedienungsanleitungen sind geschriebene Dokumente, die entweder in Druckform Papier oder als elektronisches Dokument PDF oder XPS vorliegen und Anweisungen enthalten, wie man etwas macht oder benutzt.

Fernsehern, Stereo-Anlagen, Telefonen, MP3-Playern, Haushalts- und Gartengeräten, bei. Gute Bedienungsanleitungen enthalten Informationen über die Produktbesonderheiten, lehren den Konsumenten, diese richtig einzusetzen und sind dabei leicht verständlich geschrieben. Im Folgenden finden sich Punkte, die bei der Erstellung des Inhalts sowie des Layouts einer Bedienungsanleitung zu beachten sind.

Anmelden Facebook. Du hast noch kein Konto? Erstelle ein Konto. Gemeinschaftsportal Zufällige Seite Über Uns Kategorien. In diesem Artikel: Eine angemessene Benutzungsdokumentation erstellen. Die Bestandteile einer Bedienungsanleitung.

Ein gut lesbares Handbuch erstellen. Verwandte Artikel. Teil 1 von Bestimme, an wen sich deine Anleitung richtet. Um erfolgreich eine Bedienungsanleitung zu verfassen, musst du zunächst ein Profil der Verwender deiner Anleitung erstellen, indem du entweder ein geschriebenes Profil erstellst, oder indem du dir die Zeit nimmst, nachvollziehbare Vermutungen über die Charakteristika deiner Zielgruppe anzustellen.

Ein solches Profil ist nützlich, wenn du teil eines Teams bist, welches die Benutzungsdokumentation erstellt und kann ebenfalls hilfreich dabei sein, das Produkt vom Konzept zur endgültigen Form zu entwickeln. Bei der Erstellung eines solchen Profils, ist zu beachten: Wo die Benutzer die Anleitung verwenden werden, wie beispielsweise zu Hause, im Büro, an einem entfernten Arbeitsort oder im Auto.

Das würde nicht nur den Inhalt bestimmen, sondern auch den Stil, in dem die Anleitung geschrieben ist. Wie die Benutzer das Handbuch verwenden. Wenn die Verwender es nur sporadisch verwenden oder nur bestimmte Informationen nachschlagen wollen, sollte es in erster Linie als Referenzdokument verfasst sein. Wenn die Nutzer es jedoch ständig zu Rate ziehen, sollte die Referenzsektion von einem Einführungsteil und Anweisungen zu den gebräuchlichsten Verwendungsmöglichkeiten des Produktes begleitet werden.

Wie viel Erfahrung haben die Benutzer mit diesem oder ähnlichen Produkten. Wenn das Produkt brandneu ist oder sich völlig von ähnlichen Produkten unterscheidet, wirst du in der Anleitung erklären müssen, inwiefern es sich von anderen Produkten unterscheidet und Informationen beifügen müssen, wie man beginnen sollte.

Beschäftigt sich das Produkt mit Schwierigkeiten, mit denen sich Benutzer häufig auseinandersetzen müssen, wie das z. Entspreche den Bedürfnissen deiner Leser in einer für sie verständlichen Form. Vorrausgesetzt der Benutzer verfügt nicht über ein ausgeprägtes Technikverständnis, ist es am Besten technische Fachbegriffe zu vermeiden und sich stattdessen auf klare und simple Erklärungen zu beschränken.

Manchmal ist es unmöglich Fachbegriffe zu vermeiden, wie beispielsweise bei einer Software zur Erstellung von Diagrammen, welche Fibonacci-Diagramme, sowie üblichere Torten- und Säulendiagramme enthält. In solch einem Fall kann es hilfreich sein, die Begriffe zu erklären und Hintergrundwissen dazu zu liefern, wie z.

Beschreibe das Problem, mit dem der Nutzer konfrontiert ist und liefere eine Lösung dazu. Eine bestimmte Eigenschaft eines Produkts als Lösung für ein generelles Problem zu liefern funktioniert gut bei der Vermarktung des Produkts aber hat der Kunde das Produkt einmal erworben, wird er oder sie wissen wollen, wie es dafür zu verwenden ist.

Erkenne die Probleme, die den Kunden erwarten werden und beschreibe sie in deinem Handbuch gefolgt von Anweisungen zur Lösung. Wenn es sich um ein komplexes Problem handelt, zerlege es in kleinere Teile. Beschreibe jeden Teil zusammen mit Anweisungen zur Lösung und verfahre so mit jedem nachfolgenden Teil.

Teil 2 von Ein angemessenes Deckblatt und Titelseiten. Benötigt wird ein Cover, welches mehr als nur eine Schnellübersichtskarte ist und ein Titelblatt, welches aus mehr besteht als nur einem gefalteten Blatt Papier 4 oder mehr Seiten lang. Ist das Handbuch Copyright-geschützt, muss das sowohl auf dem Cover als auch auf der Titelseite vermerkt sein. Wenn es irgendwelche Konditionen oder Bestimmungen zur Verwendung der Anleitung und dem dazugehörigen Produkt gibt, beschreibe diese auf der Innenseite des Deckblatts.

Vermerke zu ähnlichen Dokumenten gehören in das Vorwort. Wenn die Benutzungsdokumentation mehr als eine Anleitung umfasst, dann erstelle hier Vermerke zu diesen anderen Dokumenten. Ist die Anleitung länger als 10 Seiten, füge ein Inhaltsverzeichnis hinzu.

Anweisungen und Referenzmaterialien kommen in den Hauptteil der Anleitung. In den meisten Fällen sollten Anweisungen und Referenzmaterialien jeweils ihre eigene Sektion haben, obwohl der Nutzer von einer Sektion auf Informationen einer anderen Sektion verwiesen werden kann.

Auf diese Weise findet der Leser die benötigten Informationen schneller. Anweisungen sollten in einer einheitlichen Struktur geschrieben werden. Beginne mit einem Überblick über den nächsten Schritt, beschreibe dann, was zu tun ist und wie das Resultat aussehen sollte.

Die einzelnen Schritte sollten durchnummeriert sein und mit Tätigkeitsverben eingeleitet werden. Referenzmaterialien können eine Liste von Zusätzen, Ratschläge zur Fehlerbehebung und häufig gestellte Fragen enthalten. Glossare und Indices können an das Ende der Anleitung gesetzt werden, obwohl eine Liste wiederkehrender Fachbegriffe auch am Anfang erscheinen kann. Ein Index kann weggelassen werden, sollte die Anleitung weniger als 20 Seiten lang sein.

Verwende graphische Darstellungen zur Verdeutlichung des Texts. Solche Darstellungen können bestimmte Schritte besser verdeutlichen als reiner Text, vor Allem bei komplexeren Anweisungen als Bestätigung, dass der Nutzer die einzelnen Schritte richtig durchführt.

Graphische Darstellungen könne mit Hilfe computergestütztem Zeichnen CADZeichenprogrammen Bildbearbeitungsprogrammen und Digitalkameras erstellt werden. Hast du so eine graphische Darstellung erstellt, speichere es ab, so weit komprimiert, wie es deine Textverarbeitungs- oder Desktop-Publishing-Software zulässt.

Falls nötig, zerlege das Originalbild in kleinere Teile und zeige den jeweils relevanten Teil zusammen mit dem passenden Text. Das macht sie optisch ansprechender für die Verwender. Achte bei Screenshots auch auf die korrekte Farbdarstellung für den Fall, dass das Handbuch in Farbe ist. Teil 3 von Suche dir ein paar gut lesbare Schriftarten aus. Auch wenn Computer eine Vielzahl verschiedener Schriftarten darstellen können, ist das Ziel eines Benutzerhandbuchs immer gut lesbar zu sein.

Um dieses Ziel zu erreichen ist es am Besten, nur ein paar wenige Schriftarten zu wählen, die gut miteinander aussehen. Es gibt zwei Sorten von Schriftarten: serif- und sans serif-Schriftarten. Serif-Schriftarten weisen kleine Verschnörkelungen an den Strichen der einzelnen Buchstaben auf. Beispiele dafür sind Times New Roman, Baskerville und Book Antiqua. Sans serif-Schriftarten haben keine Verzierungen.

Beispiele sind Arial, Calibri und Century Gothic. Generell solltest du schlichte Schriftarten, wie z. Arial oder Times New Roman für dein Handbuch verwenden. Schreibst du eine Anleitung z. Hast du dich einmal für die Schriftarten entschieden, die du verwenden möchtest, erstelle eine Testseite, um sicherzugehen, dass die verschiedenen Schriftarten auch gut zusammenpassen.

Diese solltest du auch der Person zeigen, die für das Gesamtbild des Handbuchs verantwortlich zeichnet, bevor du fortfährst. Mache dir Gedanken zum Layout. Wenn du dich für die Schriftarten entschieden hast, musst du entscheiden, wo auf der Seite welche Elemente sein sollen.

Hinweistexte könntest du in farbigen oder schattierten Kästen unterbringen, um sie vom restlichen Text abzuheben. Benutze aber Farben oder Schattierungen, die den Text nicht unlesbar machen. Verwende vernünftige Seitenabstände mit mehr Spielraum an den Kanten, wo das Buch gebunden wird. Überlege dir die Art der Bindung deiner Anleitung. Wenn das Handbuch mehr als vier Seiten enthält, müssen diese irgendwie gebunden werden. Die meisten billigeren Handbücher mit 48 oder weniger Seiten werden auf diese Art gebunden.

Sattelheftbindung findet sich seltener bei Bedienungsanleitungen, auch wenn ein paar längere Nutzerhandbücher auf diese Weise gebunden werden Das originale, von JASC Software produzierte Paint Shop Pro wurde mit einem sattelheftgebundenem Handbuch ausgeliefert. Spiralbindungen finden sich bei Handbüchern, die eher in raueren Umgebungen, wie z.

Benutze die Dokumentenvorlage beim Erstellen des Handbuches. Viele Textverarbeitungsprogramme bieten die Möglichkeit eine Dokumentenvorlage für dein Handbuch zu erstellen. Parallel zum Erstellen deines Textes erscheint eine Vorlage in deiner gewählten Schriftart. Du kannst dir eine der Vorlagen aussuchen z. Versuche alle Vorlagen, die du benötigst im Vorraus zu erstellen, um dir Zeit zu sparen. Benutze Feldschlüssel oder Textvariablen, wo möglich. Diesen kannst du Werte zuordnen, wie z.

Siehst du dir die Vorlage an oder druckst den Text, wird statt der Zahl der eigentliche Text erscheinen. Falls sich der Name des Produkts ändert oder du den Titel des Handbuchs oder eines Kapitels änderst, wird es einfacher sein die Information durch änder der Variablen zu ändern als jede der Informationen zu suchen und zu ersetzen. Verwandte wikiHows.

Über dieses wikiHow wikiHow ist ein "wiki", was bedeutet, dass viele unserer Artikel von zahlreichen Mitverfassern geschrieben werden. Kategorien: Schreiben. Italiano: Creare un Manuale d'Uso. Nederlands: Een handleiding maken. Bahasa Indonesia: Membuat Panduan Pengguna.

Diese Seite wurde bisher

Du möchtest ein Handbuch erstellen, weisst aber nicht wie du vorgehen sollst, weil du bisher immer nur auf der Seite des Lesers warst? Dann bist du hier genau richtig! Denn es gibt eine einfache Anleitung für die Erstellung eines Handbuchs und in diesem Beitrag zeigen wir sie dir. Von der Gebrauchsanweisung eines neuen Elektronikgeräts, über die Anleitung zum Aufbau eines neuen Möbelstücks bis hin zum Leitfaden für das korrekte Ausfüllen der Steuererklärung — in unserem Alltag sind wir immer wieder auf Unterstützung angewiesen, um eine Tätigkeit korrekt auszuführen oder ein Produkt richtig zu nutzen.

Doch oftmals ärgern wir uns bei der Lektüre dieser Gebrauchsanweisungen. Denn entweder ist die gesuchte Information unauffindbar oder wir verstehen nicht, was wir tun sollen. Wahrscheinlich bist du genau deshalb hier. Weil du den Lesern deines Handbuchs diese Erfahrung ersparen möchtest. Die Erstellung eines Handbuchs ist übrigens ein Aufwand, der sich lohnt.

Denn die Unterstützung, die ein Benutzer eines Produkts oder einer Dienstleistung erhält, ist ein wichtiger Teil des Gesamteindrucks. Ob dein Unternehmen weiterempfohlen wird oder nicht, hängt also auch von der Qualität deines Handbuchs ab. Starten wir mit der Grundvoraussetzung für das Schreiben eines guten Handbuchs: Du musst ein Experte sein, was das Thema deines Handbuchs angeht! Um ein Produkt oder eine Tätigkeit erklären zu können, musst du jeden Aspekt davon verstehen. Falls du noch nicht alles über das Thema weisst, über das du ein Handbuch schreiben sollst, lohnt es sich dies jetzt nachzuholen.

Denn erst dann wirst du in der Lage sein, ein hilfreiches Benutzerhandbuch zu erstellen. Vergiss nicht, dass die meisten Leser deines Handbuchs Benutzer ohne Vorkenntnisse sind. Was für dich als Experte klar ist, ist für Anfänger allenfalls schwer zu verstehen. Der erste Schritt bei der Erstellung deines Handbuchs ist deshalb die Beantwortung folgender Frage:. Je besser sich die Zielgruppen eines Produktes oder einer Dienstleistung eingrenzen lassen, umso leichter ist es, ein Handbuch zu schreiben.

Denn die Kenntnisse oder Nicht-Kenntnisse der Benutzer geben den Schwierigkeitsgrad der Dokumentation vor. Wird ein Produkt von verschiedenen Benutzergruppen verwendet, solltest du dich immer an den Benutzern mit den wenigsten Kenntnissen orientieren.

Denn sie sind am stärksten auf Unterstützung angewiesen. Doch die Anwenderkenntnisse zu kennen alleine, reicht nicht. Noch wichtiger als der Detaillierungsgrad der Bedienungsanleitung ist es, die Probleme der Benutzer zu verstehen. Sprich mit dem Kundendienst deines Unternehmens oder wende dich allenfalls direkt an die Benutzer. Wo gibt es die meisten Schwierigkeiten? Welche Funktionen sind zentral?

Die Erkenntnisse aus diesen Gesprächen helfen dir, die richtigen Schwerpunkte für das Handbuch abzuleiten. Die wenigsten Nutzer werden das komplette Handbuch lesen. Meist wird nur nach der Lösung für ein konkretes Problem gesucht.

Für den Leser des Handbuchs ist es wichtig, den entsprechenden Abschnitt so einfach und schnell wie möglich finden zu können. Eine logische Struktur und ein detailliertes Inhaltsverzeichnis sind deshalb unbedingt notwendig. Ein Handbuch lebt von einfachen und klar verständlichen Sätzen. Auf komplizierte Formulierungen und Fachbegriffe solltest du zugunsten der Benutzerfreundlichkeit verzichten. Falls Fachwörter nicht zu vermeiden sind, hilft die Erstellung eines Glossars.

Dort hast du die Gelegenheit, diese Fachbegriffe zu erklären. Genauso wichtig wie eine einfache Sprache ist eine konsequente Terminologie. Verwende für gleiche Dinge immer dieselbe Bezeichnung. Die Verwendung von Synonymen wie Anlage, Instrument, Apparat oder sonstigen Begriffen sorgt für Verwirrung bei den Lesern.

Das gilt im Übrigen nicht nur für die Bezeichnung von Gegenständen, sondern auch für Tätigkeiten. Das Ziel eines Handbuchs ist es schliesslich nicht zu unterhalten, sondern schnell und einfach Lösungen anzubieten. Ein Handbuch ist kein Roman. Es soll deine Leser ermutigen, ihre Probleme schnell lösen zu können. Lange Textblöcke wirken kontraproduktiv. Fasse sich deshalb so kurz wie möglich, achte aber trotzdem darauf, dass das Handbuch vollständig ist und jeden Aspekt berücksichtigt.

Passive Formulierungen gehören nicht in ein Handbuch. Schreibe so, als würdest du den Benutzer direkt ansprechen. Formuliere deine Erklärungen im Aktiv und verwende einfache Handlungsaufforderungen. Ein Handbuch zu schreiben ist eine anspruchsvolle und umfangreiche Aufgabe. Was für dich verständlich ist, muss nicht zwingend für andere gelten. Es kann deshalb nicht schaden, wenn du dein Handbuch von einem Kollegen oder einer Kollegin kontrollieren oder gegenlesen lässt.

Ein weiterer Punkt, der sich positiv auf die Benutzerfreundlichkeit eines Handbuchs auswirkt, ist die Verwendung von Bildern. Sowohl Fotos als auch Illustrationen eigenen sich hervorragend, um eine beschriebene Tätigkeit verständlicher zu machen. Besonders dann, wenn diese kompliziert ist. Zuletzt gilt es, sich über das Format des Handbuchs Gedanken zu machen. Zum einen hast du die Möglichkeit, eine gedruckte Form der Bedienungsanleitung direkt mit dem Produkt mitzuliefern. So kann sich der Benutzer vor der ersten Verwendung des Produktes mit dessen Funktionen und Eigenschaften vertraut machen.

Ebenfalls zu empfehlen ist eine Online-Version deines Handbuchs. Denn das Internet ist heute eine der wichtigsten Informationsquellen. Es ermöglicht dem Benutzer schnell nach den gewünschten Informationen zu suchen, ohne dafür die Papierform des Handbuchs zu benötigen. Zudem lässt sich die Ausgabe verschiedener Inhaltselemente für jeden Kanal individuell steuern. So kann die Online-Version des Handbuchs beispielsweise mit Videos ergänzt werden.

Ein Benutzerhandbuch zu erstellen ist eine anspruchsvolle Aufgabe. Doch wenn du dich gut darauf vorbereitest und stets aus der Perspektive des Benutzers denkst, wirst du dieses Dokument problemlos erstellen können. Denk daran, ein Benutzerhandbuch ist nicht nur ein notwendiges Übel, sondern eine gute Gelegenheit den Gesamteindruck deines Unternehmens positiv zu beeinflussen.

Datum: Juni Lesezeit: 5 Minuten. Stephanie Suppiger. Der erste Schritt bei der Erstellung deines Handbuchs ist deshalb die Beantwortung folgender Frage: Für wen schreibe ich dieses Handbuch? Für die Erstellung eines Handbuchs ist es hilfreich, die Perspektive der Zielgruppe einzunehmen. Je schneller und einfacher ein Nutzer die gesuchte Lösung in einem Handbuch findet, umso besser.

Es gibt 5 einfach Tipps, die dich beim Schreiben eines guten Handbuchs unterstützen: 1. Halte es einfach und verständlich Ein Handbuch lebt von einfachen und klar verständlichen Sätzen. Verwende gleiche Bezeichnungen Genauso wichtig wie eine einfache Sprache ist eine konsequente Terminologie.

Fasse dich so lange wie nötig und so kurz wie möglich Ein Handbuch ist kein Roman. Benutze aktive Formulierungen Passive Formulierungen gehören nicht in ein Handbuch. Frage nach Unterstützung Ein Handbuch zu schreiben ist eine anspruchsvolle und umfangreiche Aufgabe. Ob das Handbuch in einer gedruckten oder elektronischen Form bevorzugt wird, hängt von der Situation und von den Präferenzen des Nutzers ab. Neues und Wissenswertes auf unserem Publikations-Blog. Factsheet erstellen leicht gemacht — So geht es!

Einfache Prozesse: Publikationen erstellen und publizieren leicht gemacht. Online-Geschäftsbericht: Das sind die Vorteile eines digitalen Geschäftsberichts.