So erstellen Sie ein Benutzerhandbuch

https://www.wikihow.it/Creare-un-Manuale-d%27Uso

07-08-2024 |
italia |
fai da te |
Programma di scrittura o pubblicazione |
Programma di grafica o registrazione visiva |

Benutzerhandbücher sind physisch geschriebene Anleitungen (auf Papier) oder elektronische Dokumente (PDF oder XPS), die Anweisungen dazu geben, wie etwas zu tun oder zu verwenden ist.Obwohl bei „Benutzerhandbüchern“ meist etwas mit Computersoftware zu tun hat, sind Benutzerhandbücher auch an Computern oder anderen elektronischen Geräten wie Fernsehern, Stereoanlagen, Telefonen und MP3-Playern sowie an Haushaltsgeräten und Geräten aus dem Garten angebracht.Ein gutes Benutzerhandbuch informiert Benutzer über die Funktionen des Produkts und vermittelt ihnen auf effektive und leicht zugängliche Weise die jeweiligen Bedienungsvorgänge.Im Folgenden sind die Elemente aufgeführt, die bei der Erstellung effektiver Inhalte und des effektiven Layouts eines Benutzerhandbuchs zu berücksichtigen sind.

Teil 1

Teil 1 von 3:

Erstellen einer benutzerfreundlichen Dokumentation

PDF herunterladen

1
Definieren Sie den Referenzbenutzer. Um ein erfolgreiches Handbuch zu schreiben, müssen Sie ein Profil Ihres Benutzers erstellen, entweder formell, indem Sie ein schriftliches Profil erstellen, oder informell, indem Sie sich die Zeit nehmen, vernünftige Annahmen über die Eigenschaften Ihres Benutzers zu treffen.Ein Profil wie dieses ist nützlich, wenn Sie Teil eines Teams sind, das Benutzerdokumentation schreibt, und es kann auch dabei hilfreich sein, das Produkt von der Idee bis zur endgültigen Form zu bringen.Beim Schreiben eines Benutzerprofils sind unter anderem folgende Elemente zu berücksichtigen:
- Wo Benutzer das Handbuch verwenden, zu Hause, im Büro, an einem entfernten Arbeitsplatz oder im Auto.Dies könnte sich nicht nur auf den Inhalt, sondern auch auf den Stil des Handbuchs auswirken.
- Wie Benutzer den Leitfaden verwenden werden.Wenn das Handbuch nur selten konsultiert oder nach Informationen gesucht werden muss, sollte es sich in erster Linie um ein Referenzdokument handeln.Wenn es sich um etwas handelt, das von Benutzern zunächst häufig zu Rate gezogen wird, sollte dem Referenzabschnitt ein Abschnitt „Erste Schritte“ und Anweisungen zu den häufigsten Verwendungszwecken des Produkts beigefügt sein.
- Wie viel Erfahrung Benutzer bereits mit dem Produkt oder anderen in derselben Kategorie haben.Wenn Ihr Produkt neu ist oder erhebliche Unterschiede zu ähnlichen Produkten aufweist, müssen Sie eine Erläuterung dieser Unterschiede sowie Anweisungen für die ersten Schritte bei der Verwendung beifügen.Wenn sich das Produkt mit etwas befasst, mit dem Benutzer häufig Probleme haben, beispielsweise mit vielen Computeranwendungen, müssen Sie angemessene Informationen und Details in einem verständlichen Stil bereitstellen.
2
Gehen Sie auf die Bedürfnisse Ihrer Benutzer so ein, dass sie diese verstehen können. Sofern der Benutzer nicht über technische Erfahrung verfügt, ist es wahrscheinlich am besten, spezifische Terminologien zu vermeiden und klare und einfache Erklärungen zu bevorzugen.Der Text sollte außerdem so gestaltet sein, dass er den Argumenten der Benutzer Rechnung trägt.Das Auflisten von Produktmerkmalen durch Gruppieren nach ihren Funktionen ist oft sinnvoller als die häufiger verwendete Reihenfolge in Listen.
- Manchmal führt kein Weg an den Fachbegriffen vorbei, beispielsweise bei Diagrammsoftware, die Fibonacci-Diagramme sowie häufigere Kreis- und Balkendiagramme umfasst.In ähnlichen Fällen ist es sinnvoll, den Begriff zu definieren und eine Erklärung bereitzustellen, indem man sich beispielsweise mit der Definition und dem Nutzen von Fibonacci-Tabellen in der Finanzanalyse befasst.
3
Erklären Sie das Problem, das der Benutzer lösen möchte, und präsentieren Sie dann die Lösung. Nur die Lösung eines generischen Problems bereitzustellen, funktioniert in der Verkaufsphase des Produkts, aber sobald der Benutzer es gekauft hat, muss er verstehen, wie er es am besten nutzt.Identifizieren Sie spezifische Probleme, auf die der Benutzer stoßen wird, geben Sie sie im Benutzerhandbuch an und fahren Sie dann mit den Anweisungen zu deren Lösung fort.
- Wenn das Problem komplex ist, zerlegen Sie es in kleinere Teile.Listen Sie jeden Teil mit Anweisungen zur Lösung oder Handhabung auf und ordnen Sie sie dann der Reihe nach an.Dieser Vorgang wird als „Chunking“ bezeichnet.
Werbung

Teil 2

Teil 2 von 3:

Elemente eines Benutzerhandbuchs

PDF herunterladen

1
Fügen Sie die entsprechenden Deck- und Titelseiten bei. Sie benötigen für jedes Benutzerhandbuch ein Deckblatt, das aus mehr als nur einer Referenzkarte besteht, und Deckblätter für Handbücher, die länger als ein gefaltetes Blatt Papier sind (4 oder mehr Seiten lang).
- Sofern das Handbuch urheberrechtlich geschützt ist, muss dies sowohl auf dem Umschlag als auch auf der Titelseite angegeben werden.
- Wenn Sie die Nutzungsbedingungen für das Handbuch und das zugehörige Produkt angeben müssen, müssen Sie diese auf der Innenseite des Umschlags angeben.
Wenn die Benutzerdokumentation mehr als einen Band umfasst, geben Sie hier Verweise auf die anderen Dokumente mit den richtigen Versionen an.Die Einleitung ist auch der Teil, in den Sie bei Bedarf den Abschnitt „So verwenden Sie dieses Handbuch“ einfügen können.
4
Platzieren Sie Anweisungen/Methoden und Referenzmaterialien im Hauptteil des Handbuchs. In vielen Fällen sollten die Methoden und Referenzmaterialien jeweils einen eigenen Abschnitt haben. Sie können den Benutzer jedoch jederzeit anweisen, auf bestimmte Inhalte von einem Abschnitt zum anderen zu verweisen.Auf diese Weise kann der Benutzer die gesuchten Informationen schneller finden.
- Die Methoden sollten im gesamten Abschnitt mit den Anweisungen des Handbuchs einheitlich beschrieben werden.Beginnen Sie mit einem Überblick über die Aufgabe und beschreiben Sie dann, was der Benutzer tun muss und welche Ergebnisse er erzielen soll.Die Schritte sollten nummeriert sein und mit Aktionsverben beginnen, ebenso wie die Schritte in jedem Abschnitt dieses Artikels.
- Referenzmaterialien können eine Liste mit Optionen, Tipps und häufig gestellten Fragen enthalten.Gegen Ende des Handbuchs können Glossare und Anhänge hinzugefügt werden, obwohl am Anfang möglicherweise eine Liste häufig verwendeter Begriffe erscheint.Auf den Index kann verzichtet werden, wenn das Handbuch weniger als 20 Seiten umfasst.
5
Verwenden Sie bei Bedarf Grafiken, um den Text zu unterstützen. Grafiken oder Screenshots können bestimmte Punkte im Handbuch besser veranschaulichen als Text, insbesondere bei komplexen Verfahren, bei denen Benutzer eine visuelle Bestätigung der korrekten Ausführung benötigen.Grafiken können mit CAD-Programmen oder Grafiksoftware, digitaler Bearbeitung und Digitalkameras erstellt werden, oder im Falle von Screenshots über die eingebaute Funktion des Computers („Stempel“/cmd+Umschalt+3) oder ein Grafikprogramm, das dies bereitstellt Bildschirmaufzeichnungsoption.
- Sobald die Grafiken erstellt wurden, speichern Sie sie in einem komprimierten Format, damit sie in Schreib- oder Veröffentlichungsprogrammen verwendet werden können.Sie sollten auch die Dateigröße reduzieren, um die Einbindung in die Seite zu erleichtern, ohne die Details für den Benutzer zu beeinträchtigen (ggf. müssen Sie das Originalbild aufschlüsseln und die relevanten Teile anzeigen, während Sie den Text durchgehen). .
- Wenn Sie in Ihren Methoden zahlreiche Grafiken verwenden, achten Sie auf einheitliche Abmessungen, unabhängig davon, ob sie alle die gleiche Länge und Breite haben oder immer auf die gleichen Proportionen gegenüber ihrer Originalgröße verkleinert werden.Dadurch werden die Bilder für den Benutzer einladender.Stellen Sie beim Speichern von Screenshots auf einem Computer ebenfalls sicher, dass der Computer bei diesem Schritt auf eine Standardfarbe eingestellt ist, falls das Handbuch Sie dazu auffordert, diese Farben beizubehalten.
- Während Grafikprogramme wie Photoshop und Paint Shop Pro gute Bildschirmspeicherfunktionen bieten, können Sie mit Spezialprogrammen wie SnagIt auch Bildschirme einfach bearbeiten, katalogisieren und anheften.
Werbung

Teil 3

Teil 3 von 3:

Entwerfen eines lesbaren Handbuchs

PDF herunterladen

1
Wählen Sie ein paar lesbare Schriftarten. Obwohl Computer viele verschiedene Schriftarten unterstützen können, ist das Ziel eines Benutzerhandbuchs eine einfache Lesbarkeit.Die beste Möglichkeit, dieses Ziel zu erreichen, ist die Auswahl einiger gut aufeinander abgestimmter Schriftarten.Es gibt zwei Kategorien von Schriftarten:„Serif“ und „Sans Serif“ (mit oder ohne Serif).
- Serifenschriften haben kleine Abschlüsse am Ende der Hauptstriche der Buchstaben.Zu den Serifenschriften gehören Times New Roman, Baskerville und Book Antiqua.Serifen funktionieren am besten in großen Textblöcken der Größe 10–12 im Hauptteil eines gedruckten Benutzerhandbuchs.
- Serifenlose Schriftarten weisen nur die Striche auf, die die Buchstaben ohne Endungen bilden.Zu den serifenlosen Schriften gehören Arial, Calibri und Century Gothic.Diese Schriftarten können für große Textblöcke mit einer Größe von 8–10 in einem Online-Handbuch oder PDF verwendet werden, obwohl das Fehlen von Endungen die Lesbarkeit von Sätzen mit einer Größe von 12+ erschwert.In größeren Größen lassen sie sich jedoch gut zur Darstellung von Überschriften und Überschriften einsetzen und eignen sich in kleineren Größen gleichermaßen für Fußzeilen und Zahlen in Spalten oder Tabellen.
- Generell sollten Sie für Ihr Benutzerhandbuch neutrale Schriftarten wie Arial oder Times New Roman wählen, bei Zitaten oder Titeln ist es jedoch besser, sich für eine dekorative Schriftart zu entscheiden, wenn Sie beispielsweise für ein Videospiel mit Fantasy oder Wissenschaft schreiben Belletristikeinstellungen (bei Auszügen aus demselben Text können Sie häufig dieselbe Schriftart im „kursiven“ Format verwenden).
- Nachdem Sie die Schriftarten ausgewählt haben, die Sie verwenden möchten, erstellen Sie eine Testseite, um zu überprüfen, ob die Schriftarten zusammen auf dem Papier gut aussehen.Möglicherweise möchten Sie diesen Nachweis auch jedem zeigen, der das Aussehen des Handbuchs genehmigen muss, bevor Sie fortfahren.
2
Denken Sie über das Layout nach. Nachdem Sie die Schriftarten für Ihr Benutzerhandbuch ausgewählt haben, müssen Sie sich für die Positionierung der verschiedenen Elemente der Seiten entscheiden.
- Normalerweise möchten Sie den Handbuch- oder Kapiteltitel in der Kopfzeile oder am Ende der Seite platzieren, idealerweise mit dem Handbuchtitel auf der linken Seite und dem Kapiteltitel auf der rechten Seite.Seitenzahlen sollten oben oder unten, nach außen (Kopf- oder Fußzeile) oder in der Mitte (nur Fußzeile) stehen.Möglicherweise möchten Sie die erste Seite jedes Abschnitts oder Kapitels von den anderen unterscheiden, indem Sie die Seitenzahl in der Mitte und die folgenden in der äußeren Ecke der Kopfzeile platzieren.
- Möglicherweise möchten Sie Teile des Textes in farbigen oder schattierten Feldern zeichnen, um sie vom Rest des Textes abzugrenzen.Achten Sie darauf, eine Farbe oder einen Schattierungsgrad zu wählen, der den Text nicht überlappt.
- Lassen Sie auf allen Seiten ausreichend breite Ränder und an den Kanten, die zusammengebunden werden, genügend Platz.
3
Berücksichtigen Sie die Art der Bindung des Benutzerhandbuchs. Wenn Ihr Handbuch mehr als 4 Seiten umfasst, müssen diese in irgendeiner Weise gebunden werden.Während interne Dokumente an einer Ecke zusammengeheftet werden können, werden externe Handbücher, die mit dem Produkt geliefert werden, normalerweise auf eine von drei Arten gebunden:
- Die seitlichen Heftklammern eignen sich für Handbücher, die aus gefalteten Papierblättern mit den Maßen 21 x 27,5 cm, 21 x 35 cm oder 27,5 x 42,5 cm bestehen.Die meisten Wirtschaftshandbücher mit weniger als 48 Seiten sind auf diese Weise gebunden.
- Die Seitennaht wird häufiger für externe Referenzhandbücher verwendet als für Bedienungsanleitungen, die nicht-automobilen Produkten beiliegen, obwohl einige längere Anleitungen auf diese Weise gebunden sind (Paint Shop Pro wurde ursprünglich mit einer nahtgebundenen Anleitung ausgeliefert, als es von JASC Software produziert wurde ).
- Die Spiralbindung eignet sich für Benutzerhandbücher, die robuster gestaltet sind, beispielsweise für Außenumgebungen, wo geheftete oder geheftete Handbücher nicht widerstehen würden.Einige Handbücher mit Spiralbindung enthalten möglicherweise auch laminierte Seiten, um zu verhindern, dass sie durch Kontakt mit Wasser oder Schlamm beschädigt werden.
4
Erstellen Sie eine Vorlage für Ihr Handbuch. Viele Schreib- und Veröffentlichungsprogramme bieten die Möglichkeit, ein Vorlagendokument für Ihr Benutzerhandbuch zu erstellen, sodass der Text beim Schreiben automatisch in der gewünschten Schriftart in dem Teil des Handbuchs erscheint, an dem Sie arbeiten (tatsächlich war dieser Artikel). (ursprünglich mit einer MS-Word-Vorlage geschrieben).Viele dieser Programme enthalten auch eine Reihe vorgefertigter Vorlagen, die Sie an Ihre Bedürfnisse anpassen können, anstatt eine Vorlage von Grund auf neu zu erstellen.
- Mit Schreib- und Veröffentlichungsprogrammen können Sie außerdem „Stile“, voreingestellte Schriftarten und -größen für Kopf- und Fußzeilen, Titel und Textkörper erstellen.Sie können einen der vordefinierten Stile auswählen (z. B. „Überschrift1“, „Normal“, „Zitat“) oder Ihren eigenen benutzerdefinierten Stil mit einem eigenen Namen erstellen.Befolgen Sie so weit wie möglich die institutionellen Namenskonventionen für Stile, wenn Sie mehrere Stile für denselben Text haben (z. B. beschriftet MS Word Überschriftenstile als „Überschrift1“, „Überschrift2“ usw.).nach Titeln, vom Haupttitel bis zu den verschiedenen Untertitelebenen).Versuchen Sie, alle benötigten Stile im Voraus zu erstellen, damit Sie nicht während des eigentlichen Schreibprozesses mit der Erstellung aufhören müssen.
Werbung

Beratung

Nutzen Sie Code- und Textvariablen nach Möglichkeit sinnvoll.Sie können ihm Werte zuweisen, beispielsweise den Namen eines Produkts, den Titel eines Handbuchs oder eines Kapitels, und diese im Dokument platzieren, anstatt den eigentlichen Text zu schreiben.Wenn Sie ein Dokument in der Vorschau anzeigen oder drucken, wird die Variable durch Text ersetzt.Wenn sich der Produktname ändert oder Sie den Namen des Handbuchs oder eines Kapitels ändern, ist es einfacher, die Informationen zu ändern, indem Sie den Wert der Textvariablen ersetzen, anstatt im Dokument danach zu suchen und ihn zu ersetzen.

Dinge, die Sie brauchen werden

Schreib- oder Veröffentlichungsprogramm
Grafik- oder visuelles Aufzeichnungsprogramm

Lizenziert unter: CC-BY-SA