Handbuch erstellen wiki


PRICE: FREE

INFORMATION

ISBN: 477840883
FORMAT: PDF EPUB MOBI TXT
DATEIGROSSE: 12,81

ERLAUTERUNG:

Handbuch erstellen wiki

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

Im Arbeitsrecht gehören Handbücher bei Unternehmen oder Behörden zu den Arbeits- und Dienstanweisungen. Exemplare geringeren Umfangs bezeichnet man als Handbüchlein. Die latinisierte Form ist encheiridium Beispiel Jean Riolan der Jüngere : Encheiridium anatomicum Die Anordnung des Wissensstoffs kann chronologisch oder vor allem nach thematischen Gesichtspunkten vorgenommen werden.

Von besonderer Bedeutung ist dabei die systematische Gliederung des Werks, die meist in der Form eines Inhaltsverzeichnisses zusätzlich separat als Übersicht geboten wird. Handbücher haben oft einen oder mehrere Herausgeber und zahlreiche Autoren, die für die Verfassung einzelner Kapitel zuständig sind. Es werden oft ganze Fachgebiete dargestellt — somit kann ein Handbuch auch in mehreren Teilen oder Bänden erscheinen. Diese beiden Aspekte unterscheiden Handbücher von Monografiendie zudem in der Regel sehr viel engere Themengebiete behandeln.

Handbücher werden in Fachkreisen oft mit einem Kurztitel zitiert z. Im Gegensatz zum Wörterbuch erfolgt die Darstellung des Stoffs in fortlaufender Prosa. Die Mischung aus beidem — alphabetische Ordnung und Prosa — bezeichnet man als Handwörterbuch. Die von Unternehmen oder der öffentlichen Verwaltung selbst erstellten Handbücher beinhalten interne Arbeitsbeschreibungen und die Sammlung von Rechtsnormendie bei der Aufgabenerfüllung durch die Sachbearbeitung zu beachten sind.

Ausführliche Gebrauchsanleitungen werden oft — als Anglizismus englisch manual — als Benutzer- Handbuch bezeichnet. Dieser Begriff findet sich auch im Bereich von Software. Traditionell wird in UNIX-Handbuchseiten die Benutzung eines Programms beschrieben, ohne auf die Details der Implementierung einzugehen, insofern ist es nur ein Teil der technischen Dokumentation.

Es richtet sich als Hilfestellung vor allem an den Benutzer. Insbesondere im WWW und bei freier Software ist es üblich, das Softwarehandbuch durch eine FAQd. Als Handbuch können auch die Regelwerke und Hintergrundbände von Rollenspielen bezeichnet werden. Die Regelwerke können dabei als Gebrauchsanleitungen betrachtet werden, während die Beschreibungen der Spielwelt durch chronologische oder thematische Anordnung des Wissensstoffs den Charakter klassischer Handbücher haben können.

Kategorien : Technische Dokumentation Handbuch Buchart Nachschlagewerk. Navigationsmenü Meine Werkzeuge Nicht angemeldet Diskussionsseite Beiträge Benutzerkonto erstellen Anmelden. Namensräume Artikel Diskussion. Ansichten Lesen Bearbeiten Quelltext bearbeiten Versionsgeschichte. Hauptseite Themenportale Zufälliger Artikel. Artikel verbessern Neuen Artikel anlegen Autorenportal Hilfe Letzte Änderungen Kontakt Spenden. Buch erstellen Als PDF herunterladen Druckversion.