Handbuch erstellen vorlage


PRICE: FREE

INFORMATION

ISBN: 147390420
FORMAT: PDF EPUB MOBI TXT
DATEIGROSSE: 19,70

ERLAUTERUNG:

Handbuch erstellen vorlage

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

Formatvorlage für Benutzerhandbücher, Bedienungsanleitungen, Produktdokumentation und IT-Dokumentation. Schreiben Sie ein Benutzerhandbuch oder eine andere Dokumentation und möchten diese professionell und übersichtlich gestalten? Dann sind Sie hier richtig! Starter-Formatvorlage für Benutzerhandbücher.

Ihre Benutzerhandbücher benötigen eventuell vor dem Veröffentlichen noch eine manuelle Feinformatierung. Die professionell entwickelte Starter-Formatvorlage für Benutzerhandbücher hilft Ihnen, diese und viele weitere Fehler zu vermeiden. Die Formatvorlage basiert auf mehr als 25 Jahren Erfahrung in der Technischen Dokumentation und in der Entwicklung von Formatvorlagen für Benutzerhandbücher und Bedienungsanleitungen.

Sie können die Formatvorlage für Benutzerhandbücher entweder direkt unverändert einsetzen, oder Sie können die Formatvorlage auf einfache Weise an Ihre unternehmensinternen Designvorgaben anpassen. Die Starter-Formatvorlage für Benutzerhandbücher ist vollständig kompatibel mit Microsoft Word, OpenOffice und LibreOffice.

In weiten Teilen funktioniert die Formatvorlage jedoch auch mit anderen Textverarbeitungsprogrammen und Autorensystemen, die Daten in den Formaten. DOCX oder. ODT lesen können. Aufgeräumtes, klares Design erleichtert die Konzentration auf die Inhalte.

Die Gestaltung der Formatvorlage ist bewusst schlicht gehalten. Leser eines Handbuchs möchten schnelle Antworten auf ihre Fragen. Sie haben wenig Interesse an grafischem Firlefanz. Design unterstützt punktuelles Lesen und Querlesen. Sehen Sie den Tatsachen ins Auge: Die meisten Leser werden Ihr Benutzerhandbuch nicht von vorne bis hinten durchlesen. Die Gestaltung der Formatvorlage unterstützt die Leser beim Überfliegen und Querlesen Ihrer Bedienungsanleitung, um die benötigten Informationen gezielt zu finden.

Ihre Kunden werden das zu schätzen wissen! Gestaltung der Formate erleichtert die Orientierung im Text. Eines der schlimmsten Dinge, die Ihren Lesern in Ihrem Benutzerhandbuch passieren könnten, wäre es, die Orientierung zu verlieren.

Die Leser würden dann die benötigten Informationen nicht finden und sich verloren führen. Beides sehr negative Erlebnisse. Die Formatvorlage für Benutzerhandbücher wurde so gestaltet, dass Leser die Struktur einer Bedienungsanleitung stets rasch erfassen können: nicht nur im Inhaltsverzeichnis, sondern jederzeit auch mitten im Text.

Leerer Platz auf einer Seite ist nicht notwendigerweise verschenkter Platz. Sie haben keine Probleme damit, in einer schicken kleinen Schriftart geschriebenen Text zu lesen? Seien Sie froh! Viele Menschen tun sich damit schwer. Zeilenlängen, die das Lesen einfach machen. Wenn zu viele Buchstaben in einer Zeile eines Handbuchs stehen, findet das menschliche Auge beim Zeilenwechsel nur schwer den Beginn der richtigen neuen Zeile.

Das ermüdet beim Lesen und erschwert unnötigerweise die Konzentration auf die Inhalte. Die Formatvorlage für Benutzerhandbücher verwendet eine ausgewogene Zeilenlänge, die das Lesen einfach macht. Semantische Formate. Die Formatvorlage für Benutzerhandbücher verwendet sogenannte semantische Formate.

Dies bedeutet, dass die Formate nicht entsprechend ihres Aussehens benannt sind, sondern entsprechend ihres vorgesehenen Verwendungszwecks: der Semantik. Wenn Sie z. Sie brauchen lediglich das Aussehen des bestehenden Formats zu ändern, aber nicht dessen Namen. Benutzerfreundliche Namenskonventionen. Alle in der Formatvorlage für Benutzerhandbücher definierten Absatzformate und Zeichenformate sind entsprechend eines durchdachten einheitlichen Schemas benannt.

Insbesondere sind die Formate so benannt, dass verwandte Formate immer zusammenstehend aufgelistet werden, wenn Sie in Ihrem Textverarbeitungsprogramm ein Format aus dem Formatekatalog auswählen. Den am häufigsten benötigten Formaten sind in der Formatvorlage Tastenkürzel zugewiesen. Die Tastenkürzel verwenden einen Teil des Namensschemas, so dass Sie sich die Tastenkürzel leicht merken können.

Automatische Zeilenumbrüche und Seitenumbrüche. Die Formatvorlage für Benutzerhandbücher verwendet alle verfügbaren Layout-Automatismen. So können Sie sich vollständig auf das inhaltliche Schreiben Ihrer Handbücher konzentrieren und brauchen sich nicht darum zu kümmern, manuell irgendwelche Zeilenumbrüche und Seitenumbrüche zu setzen. Jedes Format besitzt die optimalen Einstellungen zur Steuerung, ob ein Seitenumbruch den Absatz unterbrechen darf, ob ein bestimmter Absatz immer oben auf einer neuen Seite stehen soll, ob ein bestimmter Absatz immer zusammen mit einem anderen Absatz auf derselben Seite stehen soll usw.

Für internationalen Vertrieb druckbar sowohl auf A4-Papier als auch auf Letter-Papier. Mit der Formatvorlage formatierte Benutzerhandbücher lassen sich sowohl auf Papier im A4-Format ausdrucken als auch auf Papier im Letter-Format. Wenn Sie Ihre Bedienungsanleitungen in elektronischer Form ausliefern z.

Leicht anpassbar. Die Starter-Formatvorlage enthält alle Elemente, die typischerweise in einer Bedienungsanleitung vorkommen. Sie können die Formatvorlage somit unmittelbar einsetzen. Optional können Sie die Formatvorlage jederzeit anpassen, um Ihrem Handbuch ein unverkennbares Aussehen zu geben oder um das Design an die Corporate Identity Ihres Unternehmens anzupassen.

Das Anpassen der bereits existierenden Formate erfordert im Normalfall nur Grundkenntnisse in Microsoft Word oder sonstigen Autorenwerkzeug. Die Starter-Formatvorlage für Benutzerhandbücher kostet lediglich eine einmalige Gebühr von 19,- Euro. Vergleichen Sie diese Kosten selbst mit der Zeit, die Sie benötigen würden, eine vergleichbare Formatvorlage für Benutzerhandbücher von Grund auf selbst zu entwickeln!

Sie können basierend auf der Starter-Formatvorlage so viele Benutzerhandbücher erstellen, wie Sie möchten: ohne zusätzliche Lizenzkosten. Kaufen Verwenden Sie die Starter-Formatvorlage für Benutzerhandbücher, statt viele Stunden mit dem Anlegen einer eigenen Formatvorlage zu verschwenden. Tipps zum Erstellen Ihrer eigenen Formatvorlagen für Benutzerhandbücher. Beachten Sie Ihre Zielgruppe Entwerfen Sie kein Design, wie es Designern gefallen würde.

Entwerfen Sie ein Design, das auf die Bedürfnisse Ihrer Zielgruppe passt. Zum Beispiel sollte das Bordbuch eines Autos ins Handschuhfach passen. Halten Sie das Design einfach und übersichtlich Weniger ist mehr. Halten Sie die Gestaltung der Formatvorlage für Ihre Bedienungsanleitungen so schlicht wie möglich. Lenken Sie die Leser nicht von den Inhalten ab. Erstellen Sie ein Design, das den Lesern dabei hilft, die im Handbuch gegebenen Informationen schnell zu finden und mit wenig Mühe aufzunehmen.

Verwenden Sie unterschiedliche Farben nur dann, wenn diese einen bestimmten Zweck erfüllen. Reservieren Sie optisch hervorstechende Farben für besonders wichtige Dinge. Richten Sie alle Objekte an einem einheitlichen Gestaltungsraster aus. Vermeiden Sie Redundanz Lassen Sie alles weg, was keinen wirklichen Nutzen besitzt: Buchstaben, Symbole, Linien, sonstige Objekte. Es genügt auf der Titelseite. Tipp: Manchmal erfordern es die Designvorgaben eines Unternehmens, dass bestimmte Elemente zwangsweise auf jeder Seite erscheinen müssen, egal ob dies nun Sinn macht oder nicht.

Falls Sie in einem solchen Fall keine Einflussmöglichkeiten auf eine Änderung dieser Vorgaben haben Sie sollten es zumindest versuchenhalten Sie die betreffenden Elemente so unauffällig wie möglich: verkleinern Sie die Elemente, verzichten Sie auf Farben, machen Sie Text hellgrau statt schwarz, positionieren Sie die Elemente an einem möglichst wenig beachteten Ort, klar abgegrenzt vom wirklichen Inhalt.

Vermeiden Sie Überfrachtung Überfrachten Sie die Seiten Ihrer Benutzerhandbücher und Bedienungsanleitungen nicht mit einem Zuviel an Informationen. Sollte durch ein aufgeräumtes Layout Ihr Benutzerhandbuch ein wenig länger werden, ist das kein Problem.

Wenn Sie nützliche Inhalte bieten, sind Leser auch dazu bereit, am Bildschirm zu scrollen oder eine Seite umzublättern. Sie sind jedoch nicht dazu bereit, Handbücher zu lesen, die sie überfordern. Sehen Sie semantische, am Inhalt orientierte Formate vor Verwenden Sie Formatnamen, die die Bedeutung eines Formats beschreiben und nicht dessen Aussehen. Beispiel: Stellen Sie sich vor, Sie haben ein spezielles Format angelegt, das Sie immer dann verwenden, wenn der Name eines Bedienelements im Text vorkommt.

Wenn Sie semantische Formate verwenden, sind Ihre Bedienungsanleitungen automatisch darauf vorbereitet, falls Sie eines Tages einmal zu einer strukturierten Texterfassung und -verarbeitung übergehen möchten. Sie können dies erreichen, indem Sie die Namen verwandter Formate mit demselben Präfix beginnen.

Verwenden Sie dasselbe Schema einheitlich für alle Absatzformate und ein anderes Schema einheitlich für alle Zeichenformate. Verwenden Sie stattdessen die dafür vorgesehenen Absatzeigenschaften. Wenn Sie später einmal einzelne Zeilen zu Ihrem Benutzerhandbuch hinzufügen oder daraus löschen, rutscht sonst alles auf eine falsche Position. Verwenden Sie stattdessen immer manuelle Seitenumbrüche.

Besser noch: Automatisieren Sie Seitenumbrüche nach Möglichkeit vollständig. Alle Arten leerer Absätze führen zu Konflikten mit automatischen Seitenumbrüchen. Probleme mit wiederholten Leerzeichen Verwenden Sie keine Leerzeichen, um einen Text einzurücken. Definieren Sie stattdessen immer einen entsprechenden Einzug in den Absatzeigenschaften.

Wenn Sie Leerzeichen zum Einrücken eines Absatzes verwenden, müssen Sie alle Folgezeilen manuell anpassen, sobald Sie etwas ändern. In Online-Benutzerhandbüchern mit variabler Spaltenbreite funktionieren Einzüge mit Leerzeichen überhaupt nicht. Die einzige Stelle, an der das Formatieren von Texten mit Leerzeichen in einem Benutzerhandbuch sinnvoll ist, sind Zitate von Programmcode.

Wenn Sie über die Zwischenablage Programmcode in Ihr Handbuch einfügen, ist dieser typischerweise bereits mit Leerzeichen oder Tabulatoren eingerückt. Probleme mit Tabulatoren Vermeiden Sie das Verwenden der Tabulator-Taste.

Tabulatoren können zu Problemen führen, wenn Sie ein Handbuch auch online verfügbar machen wollen, denn HTML kennt keine Tabulatoren. Tabulatorzeichen müssen dann in ein oder mehrere Leerzeichen oder in Einzüge umgewandelt werden, was nur selten sauber gelingt. Anstelle von Tabulaturen verwenden Sie besser Absatzeinzüge oder eine Tabelle ohne Linien. Bedenken Sie: Selbst falls Sie heute noch keine Online-Version eines Benutzerhandbuchs bereitstellen möchten, sollten Sie sich diese Option für die Zukunft offenhalten.