So schreiben Sie klare und prägnante Benutzerhandbücher
Was ist eine Bedienungsanleitung?
Es gibt verschiedene Bezeichnungen für ein Benutzerhandbuch. Technische Dokumente, Wartungshandbücher und Bedienungsanleitungen sind alles Bezeichnungen, die sich auf dasselbe Produkt beziehen. Ein Benutzerhandbuch soll Kunden dabei helfen, Ihr Produkt oder Ihre Dienstleistung richtig zu verwenden oder Probleme zu lösen, die während der Verwendung auftreten. Es kann in gedruckter Form, digital oder in beiden Formaten bereitgestellt werden.
Bedienungsanleitungen bieten dem Endbenutzer umfassende, schrittweise Anleitungen und Hilfe bei Problemen. Jedes Benutzerhandbuch sollte ein Inhaltsverzeichnis enthalten, da es sich um Referenzmaterial und nicht um Bücher handelt, die von Anfang bis Ende gelesen werden sollten. Sie sollten Ihrem Benutzerhandbuch ein Schnellstart- oder Start-Tutorial hinzufügen, damit sich Benutzer bei der Verwendung des Produkts schnell zurechtfinden.
Arten von Benutzerhandbüchern
Benutzerhandbücher können für eine Vielzahl von Themen und Zielen erstellt werden. Hier sind einige Ihrer Möglichkeiten, also schauen wir sie uns an.
- Bedienungsanleitung
Eine Bedienungsanleitung ist eine Art Benutzerhandbuch, das einfache Anweisungen für die bestimmungsgemäße Verwendung eines Produkts enthält. - Trainingshandbuch
Diese Art von Benutzerhandbuch bietet eine Liste mit Richtlinien zum Abschluss einer bestimmten Aufgabe, eines Projekts oder Jobs. - Wartungshandbuch
Servicehandbücher sind Benutzerhandbücher, die beschreiben, wie man eine Maschine oder ein Gerät in verschiedenen Situationen pflegt und wartet.tages seiner Lebensdauer. - Bedienungsanleitung
Benutzerhandbücher sind technische Veröffentlichungen, die die ordnungsgemäße Verwendung oder Bedienung eines Produkts erklären. - Bedienungsanleitung
In Betriebshandbüchern werden geschäfts- oder organisationsspezifische Rollen, Pflichten und Verfahren beschrieben. - Handbuch zu Organisationsrichtlinien
Ein Organisationsrichtlinienhandbuch ist die Dokumentation, die die Richtlinien, Vorgehensweisen und Best Practices eines Unternehmens definiert. - Handbuch zu Standardarbeitsanweisungen (SOPs)
Benutzer profitieren von den detaillierten Anweisungen eines Handbuchs mit Standardarbeitsanweisungen zur Durchführung festgelegter Verfahren.
Warum braucht Ihr Unternehmen Benutzerhandbücher?
Mithilfe eines Benutzerhandbuchs sind Menschen besser in der Lage, Probleme selbst zu lösen. Ein gutes Benutzerhandbuch kann Ihren Kunden die Werkzeuge an die Hand geben, die sie brauchen, um in der heutigen Kultur der sofortigen Bedürfnisbefriedigung schnell und effektiv den gewünschten Nutzen aus Ihrem Produkt oder Ihrer Dienstleistung zu ziehen.
Ein hervorragender Kundendienst muss durch Benutzerhandbücher ergänzt werden. Das Schreiben hervorragender Benutzerhandbücher bietet die folgenden Vorteiletags für Ihr Unternehmen:
- Um Onboarding und Training zu vereinfachen
Gut geschriebene Benutzerhandbücher können die Einarbeitung und Schulung vereinfachen. Das stimmt, durch die Entwicklung und Implementierung erstklassiger Benutzerhandbücher können sowohl Ihre Mitarbeiter als auch Ihre Kunden profitieren.
Ihr Unternehmen kann Benutzerhandbücher verwenden, um neuen Mitarbeitern dabei zu helfen, einige der Prozesse und Systeme zu durchlaufen, die Teil ihrer neuen Rolle sind, anstatt nur schwierige persönliche Schulungen zu organisieren, die viel Zeit und Geld kosten. Da die Mitarbeiter dank der Benutzerhandbücher lernen können, während sie die Aufgaben ausführen, die mit ihrer Position verbunden sind, gehen möglicherweise weniger Stunden während der Einarbeitung verloren. - Um den Supportaufwand zu reduzieren
Benutzerhandbücher sind eine großartige Ergänzung Ihres Kundendienstes gegenüber dem Verbraucher, aber auch dem Geschäftsinhaber sind sie als Komponente des Kundensupportsystems von Nutzen.
Wenn Sie Ihren Kunden schnellen Zugriff auf ein durchsuchbares Benutzerhandbuch gewähren, ist es wahrscheinlicher, dass sie sofort eine Lösung finden und weniger wahrscheinlich einen Techniker oder Vertreter für spezielle Unterstützung kontaktieren müssen. - Um Zeit zu sparen
Sowohl Ihre Kunden als auch Ihre Mitarbeiter, vom Einsteiger bis zum Management, können durch die Verwendung von Benutzerhandbüchern Zeit sparen. Wenn Ihren Kunden Benutzerhandbücher zur Verfügung stehen, müssen sie keine Zeit damit verschwenden, Informationen zur Verwendung eines Produkts zu suchen, da sie sofort direkten Zugriff auf diese Informationen haben.
Wenn Ihre Mitarbeiter mit nützlichen Benutzerhandbüchern ausgestattet sind, müssen sie keine Zeit damit verschwenden, selbst nach Lösungen zu suchen oder die Aufmerksamkeit ihrer Kollegen und Vorgesetzten mit Fragen auf sich zu ziehen, denn sie haben Zugriff auf die Lösungen direkt in ihrem Benutzerhandbuch! - Haftungsminimierung
Eine Möglichkeit, nachzuweisen, dass Sie Ihr Produkt gründlich getestet haben und wissen, wie es sicher zu verwenden ist, besteht darin, Benutzerhandbücher zu schreiben und zu verteilen. Dies kann die Verpflichtungen, die mit der Produktion eines Produkts für die breite Öffentlichkeit verbunden sind, erheblich verringern.
Wenn Sie Warnungen und Sicherheitsvorkehrungen schriftlich festhalten und den Benutzern in einer Bedienungsanleitung zugänglich machen, ist dies eine effektive (wenn auch nicht narrensichere) Methode, um rechtliche Probleme im Zusammenhang mit Verletzungen oder anderen Schäden durch Missbrauch zu vermeiden, wenn das von Ihnen verkaufte Produkt für die Benutzer gefährlich sein könnte (denken Sie an Raumheizgeräte, Elektrowerkzeuge usw.).
Aus welchen Bestandteilen besteht die beste Bedienungsanleitung?
Es gibt einige bewährte Vorgehensweisen für die Endbenutzerdokumentation, an die man sich unbedingt halten sollte, auch wenn jedes Produkt einzigartig ist und unterschiedliche Komponenten benötigt, um eine wirklich hervorragende Benutzerdokumentation zu erstellen.
- Leichte Sprache
Nichts wird Ihre Kunden mehr verärgern – abgesehen davon, keins anzubieten – als festzustellen, dass ihr Benutzerhandbuch voller Fachjargon und schwer verständlicher Sprache ist. Ihre Benutzeranweisungen sind aufgrund dieser Sprachwahl schwer zu verwenden, was auch keinen hervorragenden Kundenservice fördert. Stellen Sie sicher, dass Sie für den Benutzer und nicht für den Entwickler schreiben, was ein entscheidender Bestandteil der Erstellung großartiger Benutzerhandbücher ist. Gehen Sie nicht davon aus, dass Ihr Endbenutzer irgendetwas weiß oder damit vertraut ist. Akronyme, Fachjargon und Büroterminologie werden dazu führen, dass sich Ihre Kunden falsch informiert, frustriert und unvorbereitet fühlen. Der optimale Punkt bei der Erstellung eines Benutzerhandbuchs besteht darin, ein Gleichgewicht zu finden, indem Sie nicht so schreiben, als wären Ihre Kunden Kinder (es sei denn, sie sind es natürlich!) und ihnen die zusätzliche Hilfe geben, die sie benötigen, um die Verwendung des Produkts in einfacher Sprache vollständig zu verstehen. - Einfachheit
Beim Schreiben eines Benutzerhandbuchs müssen die Dinge einfach gehalten werden. Dieses Konzept sollte sich sowohl im Inhalt als auch im Design widerspiegeln. Wenn Sie Ihre Dokumentation mit komplizierten Bildern und langen Textpassagen überladen, wirkt sie zu kompliziert und schwer verständlich. Diese Art von Benutzerhandbuch wird Ihre Benutzer wahrscheinlich einschüchtern und dazu führen, dass sie Ihre Helpline anrufen, anstatt zu versuchen, ihr Problem selbst zu lösen. - Visuelle Darstellung
Die Maxime „Zeigen, nicht erzählen“ ist ein Grundpfeiler beim Schreiben von Benutzerhandbüchern. Kommentierte Screenshots, Filme und andere visuelle Inhalte sind äußerst hilfreich beim Verständnis von Konzepten. Es ist häufig viel nützlicher, etwas in Aktion zu sehen, als darüber zu lesen. Visuelle Elemente lockern nicht nur lange Textpassagen auf, sondern reduzieren auch die Textmenge in Benutzerhandbüchern, die Angst machen kann. Es wurde nachgewiesen, dass Menschen visuelle Informationen 7 % schneller behalten als schriftliche Informationen. In einer Studie von Techsmith wurde außerdem gezeigt, dass 67 % der Personen Aufgaben effektiver erledigten, wenn sie Anweisungen erhielten, die kommentierte Screenshots statt nur Worte zur Informationsvermittlung enthielten. - Konzentrieren Sie sich auf das zu lösende Problem
Es ist durchaus möglich, dass jemand Ihr Produkt gekauft hat, um ein Problem zu lösen. Es ist wichtig, sich beim Verfassen des Benutzerhandbuchs, das dem Produkt beiliegt, auf dieses Problem zu konzentrieren. Anstatt alle Funktionen Ihres Produkts oder die interessanten Designelemente, die Sie integriert haben, aufzuzählen und zu besprechen, informieren Sie Ihre Benutzer auf eine Weise darüber, die die Verwendung des Produkts erleichtert. Stellen Sie das zu lösende Problem bei der Beschreibung in den Kontext der Funktionen und Vorteile Ihres Produkts. - Logischer Ablauf und Hierarchie
Um dem Benutzer klar zu machen, was er in jedem Abschnitt Ihres Benutzerhandbuchs lernen wird, verwenden Sie Überschriften und Unterüberschriften, die einer klaren hierarchischen Struktur folgen. Um Ihre Kunden mühelos von Anfang bis Ende durch alles zu führen, was sie wissen müssen, sollte die von Ihnen gewählte Hierarchie einem logischen Ablauf folgen. Stellen Sie sicher, dass Sie mit den Grundlagen beginnen und eine logische Abfolge zu den anspruchsvolleren Funktionen Ihres Produkts einbauen. - Inhaltsverzeichnis
Ihr Benutzerhandbuch ist für Leser am hilfreichsten, wenn es mit einem Inhaltsverzeichnis beginnt. Ohne sich durch viele Seiten mit Informationen wühlen zu müssen, die nichts mit dem aktuellen Problem zu tun haben, ist dies für den Leser eine vertraute Methode, schnell und einfach ein Dokument zu erkunden. - Machen Sie es durchsuchbar
Auch wenn Sie Ihre Benutzerhandbücher ausdrucken, ist es wahrscheinlich, dass die digitale Dokumentation Ihre oberste Priorität sein wird. In einer Welt, in der die meisten Menschen ständig ein Smartphone bei sich haben, werden Ihre Benutzerhandbücher höchstwahrscheinlich am häufigsten in digitalem Format verwendet. Wenn Sie Ihren digitalen Benutzerhandbüchern eine Suchfunktion hinzufügen, wird dies die Benutzerfreundlichkeit für Benutzer erhöhen, die ein Problem lösen möchten, indem sie darauf zugreifen. Dies ist ähnlich, wie ein Inhaltsverzeichnis Benutzer an die richtige Stelle in einem gedruckten Dokument führt. - Zugänglichkeit
Möglicherweise könnten einige der Personen, die Ihr Benutzerhandbuch benötigen, zusätzliche Unterstützung benötigen, um sicherzustellen, dass es richtig funktioniert. Unabhängig davon, ob sie gesetzlich vorgeschrieben sind, sind Zugänglichkeitsanforderungen im Allgemeinen eine gute Praxis. Die Einhaltung von Zugänglichkeitsanforderungen in Ihren Benutzerhandbüchern ist einfach eine hervorragende Geschäftspraxis. Es ist von entscheidender Bedeutung, Benutzerhandbücher mit Inhalten zu erstellen, die für Benutzer zugänglich sind, die visuelle, akustische oder kognitive Einschränkungen haben könnten. - Gut gestaltet
Berücksichtigen Sie beim Erstellen Ihrer Benutzerhandbücher Ihre Zielgruppe. Sie wird die Handbücher viel eher effektiv nutzen, wenn Sie etwas erstellen, das ihnen Spaß macht! Vermeiden Sie lange Textblöcke und lassen Sie viel Leerraum. Die Kombination dieser beiden Eigenschaften kann dazu beitragen, dass Verbraucher weniger Angst haben und das Lernen von etwas Neuem spannend und nicht bedrohlich erscheint. Der „Zeigen, nicht erzählen“-Ansatz, den wir zuvor beschrieben haben, gilt auch hier. Sowohl für gedruckte als auch für digitale Benutzerhandbücher ist das Hinzufügen von Bildern und Fotos zum Text eine hervorragende Alternative. Für digitale Benutzerhandbücher sorgen Videos und GIFs für Interesse und sind ein hilfreiches Element. Wenn Ihr Unternehmen einen Stilleitfaden hat, sollte Ihr Design diesem entsprechen. Andernfalls ist es wichtig, dass Ihr Benutzerhandbuch einheitlich bleibt, wenn Sie keinen haben. Die Schriftart und die Farbschemata im gesamten Dokument und idealerweise in allen Ihren Benutzerhandbüchern sollten einheitlich sein. - Kommentare von tatsächlichen Kunden oder Betatestern
Sie können erst dann feststellen, ob die von Ihnen erstellten Benutzerhandbücher so erfolgreich wie möglich sind, wenn Sie das Feedback der Personen eingeholt und angehört haben, die Ihr Produkt tatsächlich verwenden werden. Die Benutzerhandbücher, die Sie für Ihr Produkt entwickeln, sollten die Probleme berücksichtigen, die die Leute damit haben. Sie lernen vielleicht etwas, das äußerst offensichtlich erscheint, aber die Wahrscheinlichkeit ist viel größer, dass Sie etwas lernen, das Ihnen hilft, die Bedürfnisse der Kunden zu verstehen, die Sie erreichen möchten.
Wie schreibe ich eine Bedienungsanleitung?
Die Erstellung eines Benutzerhandbuchs ist eine wichtige Aufgabe, die große Auswirkungen sowohl auf Ihr Unternehmen als auch auf die Kunden haben kann, die Sie bedienen möchten. Wir haben den Prozess der Erstellung eines Benutzerhandbuchs vereinfacht, damit Sie ihn leicht nachvollziehen können, da er überwältigend sein kann.
- Identifizieren der Benutzer
Wie bei jeder anderen Kommunikation, die Sie erstellen, ist es ein wichtiger erster Schritt, den Empfänger Ihrer Mitteilung zu ermitteln. Die Zielgruppe Ihres Benutzerhandbuchs hilft Ihnen bei der Entscheidung über Aspekte wie den Ton, den Detaillierungsgrad und die Bereitstellung des Inhalts. Das Schreiben eines Benutzerhandbuchs für den Endbenutzer Ihres Produkts unterscheidet sich erheblich vom Schreiben eines Benutzerhandbuchs für einen technischen Ingenieur. Der allererste Schritt besteht darin, Ihr Publikum zu bestimmen. - Konzentrieren Sie sich auf das Problem
Benutzerhandbücher dienen dazu, bei der Problemlösung zu helfen oder jemandem beizubringen, wie man etwas Neues macht. Sie müssen genau festlegen, was Ihr Benutzerhandbuch leisten soll, und sicherstellen, dass Sie diesen Fokus beibehalten.
Es kann verlockend sein, das Thema auszuweiten und zahlreiche Funktionen oder Anwendungen für Ihr Produkt zu diskutieren. Dies kann Benutzer frustrieren und dazu führen, dass sie Ihre Kundensupport-Hotline anrufen, da die tatsächlich benötigte Antwort verschleiert wird.
Wenn Ihr Kunde ein Verbraucher ist, der gerade die Verwendung des Produkts lernt, oder ein Techniker, der es reparieren muss, konzentrieren Sie sich auf die genaue Lösung, die er benötigt. - Setzen Sie einen sequentiellen Ansatz ein
Die Anweisungen in Ihrem Benutzerhandbuch sollten in der Reihenfolge aufgeführt sein, die zum Erledigen der anstehenden Arbeit erforderlich ist. Listen Sie jeden Schritt auf, um zu beginnen. Bemühen Sie sich dann, die Aufgabe zu erledigen, während Sie die genauen Schritte einhalten, die Sie in der angegebenen Reihenfolge skizziert haben. Wenn Sie Ihre ursprüngliche Liste durchgehen, ist es möglich, vielleicht sogar wahrscheinlich, dass Sie irgendwelche s findentages, die fehlen. Außerdem stellen Sie möglicherweise fest, dass etwas, von dem Sie einmal dachten, es sei eine einzelne Aufgabe, der Übersichtlichkeit halber tatsächlich in mehrere Aktivitäten aufgeteilt werden muss.
Stellen Sie sicher, dass Sie für jeden zugewiesenen Schritt ein klares Ergebnis festgelegt haben, bevor Sie mit der nächsten Phase des Schreibens einer Bedienungsanleitung fortfahren. Bevor Sie mit der nächsten Ebene fortfahren, sollte den Lesern völlig klar sein, was sie erreichen möchten und wie es aussehen soll. - Benutzerreise zuordnen
Ziel der Erstellung eines Benutzerhandbuchs ist es, zu verstehen, wie Ihre Kunden Ihr Produkt verwenden möchten, und es ihnen dabei einfach zu machen. Sie müssen sich die Mühe machen, das Problem zu verstehen, das der Kunde lösen möchte, oder das Ziel, das er mit Ihrer Lösung erreichen möchte, sowie die Art und Weise, wie er mit Ihrem Unternehmen interagiert. Mithilfe dieser Details können Sie die notwendigen Schritte planen, um den Kunden durch den Prozess zu führen und seinen Weg vom Problem zur Lösung zu visualisieren. - Wählen Sie eine Vorlage aus
Das Schreiben und Entwickeln von Benutzerhandbüchern lässt sich durch die Erstellung einer Reihe von Vorlagen wesentlich einfacher gestalten, als Sie vielleicht denken. Ihr Verfahren kann dadurch rationalisiert werden und Konsistenz wird zu einem viel realistischeren Ziel.
In Ihrer Benutzerhandbuchvorlage sollten Sie neben der Definition von Details wie Schriftarten (Art und Größe), Kontrastanforderungen und Farbschemata auch Folgendes angeben:- Bereich für eine Einführung
- Verschiedene Unterabschnitte und Abschnitte
- Ihr gewähltes Format zur Übermittlung einer Reihe von Aktionen
- Warnhinweise und Warnungen
- Für eine Schlussfolgerung vorgesehener Bereich
- Schreiben Sie einfache und leicht verständliche Inhalte
Der Inhalt Ihres Benutzerhandbuchs sollte so unkompliziert und leicht verständlich wie möglich sein. Es ist wichtig, Format und Inhalt hinsichtlich Klarheit und Benutzerfreundlichkeit zu überdenken und zu analysieren.
Stellen Sie sicher, dass jede Phase des Prozesses nur eine Aufgabe beschreibt und verwenden Sie eine möglichst klare und kurze Sprache. Achten Sie darauf, Ihren Text so lange zu überarbeiten, bis Sie ein Benutzerhandbuch haben, das nur die wirklich notwendigen Informationen enthält. - Gehen Sie mit jedem Benutzer wie mit einem Neuling um
Gehen Sie beim Erstellen Ihrer Bedienungsanleitung davon aus, dass der Leser keinerlei Vorkenntnisse zu Ihrem Produkt hat. Schreiben Sie so, als würden Sie mit einem Laien sprechen.
Jegliche Verwendung von Fachjargon oder Fachsprache sollte vermieden werden. Natürlich wird es Situationen geben, in denen dies vermieden werden muss, aber das sollte die absolute Ausnahme sein. - Testen Sie die Produktanweisungen mit unerfahrenen Benutzern
Die Testphase beim Erstellen eines Benutzerhandbuchs ist entscheidend. Das Thema des Experiments hat einen erheblichen Einfluss auf das Ergebnis.
Die Tests sollten idealerweise an Personen durchgeführt werden, die Ihr Produkt noch nie verwendet oder die Dokumentation gesehen haben. Beobachten Sie die Personen beim Durchgehen des Benutzerhandbuchs, während sie den Vorgang abschließen, und notieren Sie, wo sie nicht weiterkommen. Anschließend sollten die Informationen entsprechend aktualisiert werden.
Ihre Tester sollten für die Bedienung des Produkts nur die Hilfe des Benutzerhandbuchs benötigen. Sie sollten nicht um weitere Unterstützung bitten müssen. Der UdSSR-Leitfaden sollte alle erforderlichen Informationen enthalten. - Erstellen Sie Inhalte mit einem praktischen Ansatz
Es sollten alle Anstrengungen unternommen werden, um konkrete Beispiele zuampDateien und detaillierte Beschreibungen aller Ergebnisse, die Benutzer nach Befolgen jedes Schritts im Benutzerhandbuch erleben könnten. Der Benutzer sollte sich aller Rückmeldungen bewusst sein, die er vom Produkt erhalten könnte, sowie aller möglichen Bilder oder Geräusche, die ihm während des Befolgens begegnen könnten. - Symbole, Icons und Codes frühzeitig erklären
Beim Schreiben eines Benutzerhandbuchs müssen Sie möglicherweise Symbole, Symbole oder Codes verwenden, um die erforderlichen Anweisungen bereitzustellen. Um Verwirrung oder Frustration beim Leser zu vermeiden, ist es wichtig, diese so früh wie möglich in Ihrem Benutzerhandbuch zu identifizieren.
FAQs zum Benutzerhandbuch
Was genau sind Benutzerhandbücher?
Benutzerdokumentation besteht aus Informationen in Form von Benutzerhandbüchern oder Benutzeranleitungen und soll Endbenutzern bei der erfolgreichen Interaktion mit einem Produkt helfen.
- Welche Arten von Benutzerdokumentation gibt es?
Traditionell wurde zur Bereitstellung von Benutzerdokumentation physische Dokumentation wie Broschüren oder Handbücher verwendet. Heutzutage werden Benutzerhandbücher immer häufiger digital erstellt und verteilt. - Was steht in Benutzerhandbüchern?
Eine Bedienungsanleitung oder ein Benutzerhandbuch zeichnet sich durch gutes Design, klare Texte und einen Fokus auf Problemlösungen aus. Ich muss ein Inhaltsverzeichnis haben, eine logische Hierarchie und einen logischen Ablauf einhalten und Inhalte anbieten, die zugänglich sind. Darüber hinaus ist ein gutes Benutzerhandbuch durchsuchbar und berücksichtigt die Anforderungen des Benutzers.views. - Wie entsteht ein Benutzerdokument?
Benutzerhandbücher können in einfachen Schritten entwickelt werden. Zunächst müssen die Ziele des Benutzerhandbuchs festgelegt und eine Strategie entwickelt werden, um deren Erreichung zu ermöglichen. Das Benutzerhandbuch muss vor der Veröffentlichung getestet und bei Bedarf aktualisiert werden. Schließlich ist es wichtig, das Benutzerhandbuch auf dem neuesten Stand zu halten und Änderungen vorzunehmen, wenn neue Updates oder Ausgaben hinzugefügt werden.