Schritt 1 Allgemeines Wissen über die Benutzerhandbuchvorlage
Bevor ich die Benutzerhandbuchvorlage und die anderen Tools, die ich für Philip entwickelt habe, tatsächlich verwende, wollte ich sicherstellen, dass wir den gleichen Ausgangspunkt haben. Ich habe ihm einige allgemeine Informationen zu Benutzeranweisungen und einige gute Beispiele für vorhandene Benutzerhandbücher zur Verfügung gestellt.
Ich habe diese Informationen unten aufgeführt.,
Was ist die Definition eines Benutzerhandbuchs?
Ein Handbuch ist eine technische Kommunikation-Dokument soll Hilfestellungen geben, um die Menschen auf, wie ein Produkt zu verwenden. Ein gutes Benutzerhandbuch hilft Benutzern, ein Produkt sicher, gesund und effektiv zu verwenden.,
Andere Namen oder andere Formen eines Benutzerhandbuchs können sein:
- Benutzerhandbuch
- Technische Dokumentation
- Bedienungsanleitung
- Bedienungsanleitung
- Schulungshandbuch
- Kurzanleitung
- Installationshandbuch
- Wartungshandbuch
- Softwarehandbuch
Neben dem primären Ziel eines Benutzerhandbuchs (um einen Benutzer zu unterstützen) könnten sekundäre Ziele darin bestehen, eine bessere Benutzererfahrung zu schaffen und die gesetzlichen Anforderungen zu erfüllen.
Ein Benutzerhandbuch besteht aus textlichen visuellen Informationen (Abbildungen, Screenshots, Tabellen etc.,) um den Benutzer bei der Ausführung bestimmter Aufgaben zu unterstützen.
Bei der Erstellung eines Benutzerhandbuchs spielt der Benutzer die zentrale Rolle. Ein gut ausgearbeitetes Benutzerhandbuch enthält nur die Informationen, die für den beabsichtigten Benutzer des Produkts relevant sind.
Das Benutzerhandbuch sollte sowohl prozedurale Informationen (Schritt-für-Schritt-Anweisungen) als auch konzeptionelle Informationen (Informationen, die der Benutzer benötigt, um prozedurale Informationen zu verstehen) enthalten.
Eine gute Bedienungsanleitung ist prägnant und verwendet jargonfreie Sprache. Ein gutes Benutzerhandbuch sollte beantworten, WIE und WELCHE Fragen., Sie sollten Informationen darüber enthalten, was passiert, wenn eine Aufgabe nicht korrekt ausgeführt wird.
In einigen Fällen soll ein Produkt von verschiedenen Benutzertypen verwendet werden. Typische Benutzertypen sind Endbenutzer, Installateur, Wartungsingenieur und Bediener. Jeder Benutzertyp benötigt einen anderen Ansatz in Bezug auf die zu verwendende Sprache, den Tonfall und die bereitgestellten konzeptionellen Informationen.
Welche Informationen sollten in einem Benutzerhandbuch enthalten sein?
Verschiedene Arten von Produkten benötigen eine bedienungsanleitung. Ein Produkt kann ein System, ein Werkzeug, ein Gerät, ein Instrument, eine Software oder eine App sein.,arnings
Verwenden einer Benutzerhandbuchvorlage
Das Hauptwerkzeug, das ich entwickelt habe, um Philip bei der Erstellung seines Benutzerhandbuchs zu helfen, ist eine Benutzerhandbuchvorlage., Die Vorlage enthält alle Informationen und mehr aus der obigen Liste. Es entspricht den Anforderungen für sein Produkt.
Die Benutzerhandbuchvorlage kann zum Erstellen Ihres Handbuchs für Ihr System, Werkzeug, Gerät, Instrument oder zum Erstellen eines Installationshandbuchs, Softwarehandbuchs, Betriebshandbuchs, Wartungshandbuchs oder Schulungshandbuchs verwendet werden.
Basierend auf der ersten Vorlage für Philip haben wir Vorlagen für folgende Produktgruppen entwickelt:
- Medizinprodukte
- Spielzeug
- Maschinen
- Elektronik
Welche Formate hat ein Benutzerhandbuch?,
Benutzerhandbücher können entweder in Papierform oder als elektronisches Dokument (PDF oder online oder auf dem Gerät in HTML) bereitgestellt werden. Die Benutzer-Handbuch-Vorlage ist ein MS Word-Dokument, das gedruckt oder online gestellt.
Benutzerhandbücher können mit einer Vielzahl von Werkzeugen erstellt werden. Jedes Werkzeug hat seine eigenen Vor-und Nachteile., content possible
All in one solution
Omni-platform publications
Contains default user manual templates
Benutzerhandbuch Beispiele
Beim Erstellen eines Benutzerhandbuchs mit Hilfe der Benutzerhandbuchvorlage kann es nützlich sein, einige gute Beispiele zu haben., Über die folgenden Links können Sie ein Benutzerhandbuchbeispiel für die Dokumentation herunterladen:
- IKEA Installationsanleitung
- Jura Benutzerhandbuch
Schritt 2 Identifizieren Sie die Benutzer Ihrer Benutzerhandbuchvorlage
Ok, sodass Philip jetzt einige Grundkenntnisse in Benutzerhandbüchern hat. Lassen Sie uns in die Details und Aktionen eintauchen.
Wenn Sie ein Handbuch schreiben möchten, das Ihrem Benutzer hilft, Probleme zu lösen, müssen Sie zuerst definieren, wer Ihr Benutzer ist. Dies kann durch Erstellen eines Benutzerprofils, auch Persona genannt, erfolgen.,
Mit einer Person treffen Sie einige vernünftige Annahmen über die Eigenschaften Ihres Benutzers. Dies ist nicht nur nützlich, um Ihre Benutzeranweisungen zu erstellen, sondern auch ein wesentliches Element zu Beginn der Entwicklung eines Produkts! Als ausgebildeter Industriedesign-Ingenieur haben wir so alle unsere Designaufgaben begonnen.
Bei der Überprüfung der ISOVOX-Website habe ich nicht einmal eine klare Beschreibung ihrer beabsichtigten Benutzer gefunden. Deshalb habe ich Philip gebeten, seine Benutzer zu definieren und Fragen zu beantworten wie:
- Wer ist der Benutzer Ihres Produkts?,
- Wird das Produkt professionell oder hauptsächlich privat verwendet?
- Welche anderen technischen Erfahrungen haben Sie? Was beschreibt den Benutzer?
Ich habe eine Vorlage erstellt, die die Fragen enthält. Ich bat Philip, die Vorlage auszufüllen.
Sie können die Vorlage selbst verwenden, um festzustellen, wer Ihr Benutzer ist. Bitte beachten Sie, dass die zweite Registerkarte auch Philipps Antworten enthält, sodass Sie ein Beispiel dafür haben, wie das Blatt verwendet werden könnte.
Aktion: Verwenden Sie die Vorlage, um Ihre Benutzer zu beschreiben.
Ich bin ein großer Fan der Visualisierung von Dingen., Wenn Sie also die Definition Ihres Benutzers noch einen Schritt weiter gehen möchten, empfehle ich Ihnen, Ihren Benutzer in Form einer Persona zu visualisieren. Wenn Sie eine Persona erstellen, geben Sie Ihrem Benutzer einen Namen, ein Alter usw., damit er zu einer echten Person wird, die Ihren Benutzer darstellt.
Ich habe das für Philip gemacht., Dies ist das Ergebnis:
Aktion: Erstellen Sie eine Visualisierung Ihres Benutzers
Wenn Sie mehr über das Definieren Ihrer Zielgruppe und das Erstellen von Personas erfahren möchten:
Schritt 3 Erstellen von Themen für die Probleme Ihres Benutzers
Identifizieren Sie zunächst die Probleme, auf die Ihr Benutzer während des Lebenszyklus des Produkts stoßen könnte und die er lösen möchte. Typische Probleme können sein: Installation des Produkts, Verwendung des Produkts, sichere Verwendung des Produkts, Wartung des Produkts und Entsorgung des Produkts.,
Wenn das Problem zu komplex ist, können Sie es in Stücke zerlegen.
Ich habe Philip gebeten, die Probleme und Lösungen zu identifizieren, auf die sein Benutzer während des Produktlebenszyklus stoßen könnte. Dazu habe ich eine weitere Vorlage für Philip erstellt. In der linken Spalte der Registerkarte Lebenszyklus werden die Phasen des Lebenszyklus eines Produkts erwähnt. Diese sind abgeleitet von der internationalen Norm für Benutzeranweisungen, der IEC/IEEE 82079. Unsere Benutzerhandbuchvorlagen entsprechen diesem Standard.
Auf der Registerkarte Lebenszyklus sehen Sie, wie Philip den Lebenszyklus an sein eigenes Produkt angepasst hat.,
Aktion: Verwenden Sie diese Vorlage und die Anweisungen auf der ersten Registerkarte, um die Probleme Ihres Benutzers während des Lebenszyklus Ihres Produkts zu identifizieren und seine Lösungen zu präsentieren.,
Wenn Sie mehr über das Definieren der Probleme Ihres Benutzers und das Erstellen von Themen erfahren möchten:
- Themenbasiertes Authoring
- Minimalismus
- Information mapping
- Chunking
Schritt 4 Definieren Sie die Struktur der Benutzerhandbuchvorlage
Philip hat nun die Probleme identifiziert, die ein Benutzer habe mit seinem Produkt während seines Lebenszyklus und er hat jetzt an die Lösung gedacht, um das Problem zu lösen. Mit anderen Worten: Philip hat die Themen für sein Benutzerhandbuch definiert., Jedes Thema kann sich nur um ein bestimmtes Thema handeln, hat einen identifizierbaren Zweck und muss alleine stehen können.
Ein Thema sollte nur die Frage eines Benutzers beantworten. Ein Benutzer möchte jeweils ein Problem lösen. Wenn ein Benutzer das Problem gelöst hat, wird er/sie das nächste Problem lösen.
Ein Thema wird zu einem Abschnitt im Benutzerhandbuch. Es kann ein Kapitel oder ein (Unter-)Absatz sein. Sobald ein Benutzer nach einer Antwort auf sein Problem sucht, wird er anhand des Inhaltsverzeichnisses herausfinden, wie er zu dieser Antwort navigieren kann.,
Ich habe Philip gebeten, die Themen zu strukturieren und ihren Platz im Benutzerhandbuch zu definieren, indem er einem bestimmten Kapitel oder (Unter-)Absatz ein bestimmtes Thema zuweist. Das Ergebnis ist auf der Registerkarte ToC zu sehen.
Aktion: So definieren Sie die Struktur Ihres Benutzerhandbuchs:
- Kopieren Sie den Inhalt von der Registerkarte Lebenszyklus in die Registerkarte ToC.
- Ersetzen Sie auf der Registerkarte ToC den Produktnamen durch Ihren eigenen Produktnamen.
- Fügen Sie links eine Spalte hinzu. Nennen Sie es „Abschnitt“.
- Falls zutreffend, organisieren Sie Ihre Abschnitte logisch.
- Bestimmen Sie, welche Themen Kapitel werden, indem Sie Kapitelnummern hinzufügen., Start Nummerierung VORBEREITUNG PRODUKT FÜR DEN EINSATZ mit Nummer 4. Wir werden im nächsten Schritt einige weitere Kapitel hinzufügen.
- Bestimmen Sie, welche Themen zu Absätzen werden, indem Sie die Abschnittsnummern hinzufügen.
- Bestimmen Sie, welche Themen zu Unterabsätzen werden, indem Sie die Unterabschnittsnummern hinzufügen.
Sie haben nun das Inhaltsverzeichnis (ToC) erstellt. Der ToC ist der Umriss Ihres Benutzerhandbuchs. Später werden wir einige weitere Themen/Abschnitte hinzufügen,wie die Einführung, Sicherheitsinformationen usw., also Mach dir keine sorgen über das hinzufügen, dass jetzt.,
Schritt 5 Sinnvolle Überschriften erstellen
Jedes Thema im Benutzerhandbuch erhält eine eigene Überschrift. Die Überschriften sind die (Unter-)Titel, die dem eigentlichen Text vorausgehen. Sie werden im ToC angezeigt, sodass der Benutzer zu den erforderlichen Informationen navigieren kann.
So hat Philip gerade die (Unter-)Titel für seine Themen erstellt.
Da die ToC-Einträge eine so wichtige Rolle spielen, um Ihrem Benutzer zu helfen, seinen Weg zu finden, und um ihm zu helfen, das zu überspringen, was NICHT wichtig ist, benötigen sie etwas mehr Aufmerksamkeit.
Grundsätzlich sollten Sie versuchen, mit drei Überschriften zu arbeiten: Überschriften der ersten, zweiten und dritten Ebene.,
Die Überschrift der ersten Ebene beschreibt, worum es im gesamten Kapitel oder Abschnitt geht (z. B. INSTALLATION DES PRODUKTS). Die Überschriften der zweiten Ebene sollten den Phrasierungsstil „Wie was“ verwenden (z. B. Wie man das Produkt zusammenbaut und wie man die elektrische Installation durchführt). Eine Überschrift der dritten Ebene verwendet Substantivphrasen (z. B. Verpackungsinhalte und zu verwendende Werkzeuge).
Ich habe Philip gebeten, seine Überschriften umzuleiten und die folgenden allgemeinen Richtlinien zu beachten:
- Verwenden Sie die oben gezeigte Struktur für die Überschrift der ersten, zweiten und dritten Ebene.,
- Stellen Sie sicher, dass die Überschriften selbsterklärend sind. Die Überschrift Pfannkuchen machen ist viel benutzerorientierter als mit dem MagicCook5000.
- Stellen Sie sicher, dass die Überschrift das gesamte Thema abdeckt. Wenn der Abschnitt die Wartung und Reparatur eines Produkts abdeckt, wäre die Überschrift Wartung unvollständig.
- Wenn möglich, versuchen Sie, Artikel am Anfang von Überschriften wegzulassen
Aktion: Schreiben Sie neue Überschriften für Ihre ToC-Einträge.
Philips ToC mit aussagekräftigen Überschriften finden Sie auf der Registerkarte ToC w. Aussagekräftige Überschriften. ,
Schritt 6 Bestimmen Sie den rechtlichen Inhalt
Abhängig von dem Markt, in dem Ihr Produkt in Verkehr gebracht oder in Betrieb genommen wird, und abhängig von der Produktgruppe, zu der Ihr Produkt gehört, gelten für Ihr Produkt spezifische Rechtsvorschriften.
Im Allgemeinen verlangt die Gesetzgebung, dass Ihr Produkt „sicher“ ist und daher allgemeine Sicherheitsanforderungen enthält, die Ihr Produkt erfüllen sollte.
Zu diesen Anforderungen gehören auch Anforderungen an den Inhalt Ihrer Bedienungsanleitung und Sicherheitshinweise.,
Um Ihr Produkt in einem bestimmten Markt zu verkaufen, sollten Sie sicherstellen, dass Ihr Benutzerhandbuch diesen Anforderungen entspricht.
In diesen beiden folgenden Artikeln erfahren Sie, wie Sie genau herausfinden können, welche Rechtsvorschriften für Ihr Produkt für den europäischen und US-amerikanischen Markt gelten und welche Anforderungen an Ihr Benutzerhandbuch gestellt werden. Pro-Tipp: Wenn bereits eine Konformitätserklärung vorliegt, finden Sie dort die entsprechenden Richtlinien.,
- So erstellen Sie konforme Handbücher für die EU
- So erstellen Sie konforme Handbücher für die USA
Philip brauchte diese Schritte nicht durchzuführen, da die Vorlage, die er verwendete, bereits den rechtlichen Inhalt enthielt, wie es die entsprechenden Richtlinien erfordern.
Für sein Produkt bedeutet dies, dass für das Benutzerhandbuch für sein Produkt folgende Informationen erforderlich sind:
EU (relevante CE-Kennzeichnungsrichtlinien: LVD, EMC, RoHS, WEEE, REACH):
- Das Benutzerhandbuch sollte in die Sprache(n) des Landes übersetzt werden, in dem das Produkt verkauft wird.,
- Das Benutzerhandbuch sollte den Verwendungszweck des Produkts beschreiben.
- Das Benutzerhandbuch sollte die vernünftigerweise vorgesehene unbeabsichtigte Verwendung des Produkts beschreiben.
- Gegebenenfalls ist die Nichteinhaltung in Wohngebieten zu erwähnen.
- Der Typ, die Chargen-oder Seriennummer oder ein anderes Element, das die Identifizierung des Produkts ermöglicht, sollten auf dem Produkt angegeben werden. Wenn das Produkt zu klein ist, kann dies in der Bedienungsanleitung platziert werden.
- Der Name, der eingetragene Handelsname oder die eingetragene Marke und die Postanschrift sollten auf dem Produkt angegeben werden., Wenn das Produkt zu klein ist, kann dies in der Bedienungsanleitung platziert werden.
- Es sollte eine Risikoanalyse durchgeführt werden, um die mit der Verwendung des Produkts verbundenen Restrisiken zu bestimmen. Sicherheitsinformationen sind anzugeben, um den Benutzer über die zu ergreifenden Maßnahmen zu informieren.
- WEEE-Informationen sind anzugeben
- Informationen über Verpackungsabfälle sind anzugeben.
Neben dieser Gesetzgebung gibt es auch eine internationale Norm für Benutzerhandbücher, die IEC/IEEE 82079-1:2019. Diese Norm wurde in der EU harmonisiert., Die Einhaltung harmonisierter Normen setzt die Konformität mit den entsprechenden Rechtsvorschriften voraus!
Die Benutzerhandbuchvorlage entspricht dieser Norm.
Ich habe auch eine IEC 82079-Checkliste erstellt, mit der Sie überprüfen können, ob Ihr Benutzerhandbuch dieser Norm entspricht.
Um ein international konformes Benutzerhandbuch zu erstellen, sollten Sie immer sicherstellen, dass Ihr Handbuch die EU -, US-und 80279-Anforderungen erfüllt.,
Aktion: Um die gesetzlichen Anforderungen in Ihrem Benutzerhandbuch festzulegen:
- Befolgen Sie die Schritte 1-2 aus den EU-Compliance-Artikeln und / oder die Schritte 1-6 aus den US-Compliance-Artikeln, um den rechtlichen Rahmen für Ihre Anweisungen festzulegen.
- Lesen Sie die Checkliste IEC 82079, um sicherzustellen, dass Ihr Handbuch der Norm 82079 entspricht.
In diesem Video erkläre ich, wie Sie ein Handbuch erstellen können, das dem 82079-Standard entspricht:
ZUM STORE
Schritt 7 Laden Sie die Benutzerhandbuchvorlage herunter und bereiten Sie sie vor
Jetzt kann Philip mit der eigentlichen Erstellung seines Benutzerhandbuchs beginnen.,
Ich bat ihn, das Inhaltsverzeichnis der Vorlage an sein eigenes Inhaltsverzeichnis anzupassen. Ohne zu entfernen und obligatorische Elemente natürlich…
Erinnern Sie sich an Schritt 4, dass ich gebeten habe, die Nummerierung der Abschnitte mit Kapitel 4 zu beginnen? Sobald Sie das Benutzerhandbuch-Vorlagendokument selbst heruntergeladen haben, werden Sie feststellen, dass einige Standardkapitel sowie einige Anhänge hinzugefügt wurden.,
Aktion: So passen Sie die Bedienungsanleitung Vorlage:
Wenn Sie mit der kostenlosen Vorlage arbeiten möchten:
- Laden Sie die kostenlose Bedienungsanleitung Vorlage Word 2013 oder 2007
- Ändern Sie die Abschnittsüberschriften nach Ihren eigenen ToC. Hinweis! Passen Sie das Inhaltsverzeichnis nicht an. Das Inhaltsverzeichnis kann automatisch aktualisiert werden, sobald Sie die Abschnittsüberschriften angepasst haben.
- Fügen Sie den obligatorischen Inhalt gemäß Schritt 6 Ihres Handbuchs hinzu.
- Falls zutreffend, ändern Sie die Abschnitte 1-3 und die Anhänge nach Ihren eigenen Bedürfnissen.,
Oder verwenden Sie eine unserer kostenpflichtigen Vorlagen, die alle obligatorischen Inhalte enthalten, wie Sie es getan haben:
- Medical Devices EU
- Medical Devices US
- Machinery EU
- Machinery US
- Electronics EU
- Toys EU
Schritt 8 Erstellen Sie den Inhalt für Ihre Benutzerhandbuchvorlage
Schreiben Sie den Verwendungszweck
Der Zweck Ihres Produkts oder besser: der Verwendungszweck ist das Herzstück eines Benutzerhandbuchs und bildet die Grundlage für die sichere und gesunde Verwendung des Produkts.,
Die Art und Weise, wie der Verwendungszweck beschrieben wird, bestimmt auch Ihre Haftung und wirkt sich auf den weiteren Inhalt der Bedienungsanleitung aus.
Die meisten Rechtsvorschriften verlangen, dass Sie eine Beschreibung des Verwendungszwecks in die Gebrauchsanweisung aufnehmen.
Die internationale Norm für Gebrauchsanweisungen, die IEC 82079-1, enthält folgende Definition für den Verwendungszweck:
Ein erschöpfender Funktionsumfang oder vorgesehene Anwendungen, die vom Lieferanten des Produkts definiert und entworfen wurden
Durch die Beschreibung des Verwendungszwecks bestimmen Sie die sichere Hülle des Produkts., Sobald Sie den Verwendungszweck festgelegt haben, können Sie sich darauf konzentrieren, nur die Sicherheits-und Benutzeranweisungen für die Verwendung des Produkts innerhalb des angegebenen Umschlags bereitzustellen.
Zusätzlich zum Verwendungszweck verlangen viele weitere Normen, Richtlinien und Vorschriften von Ihnen eine Beschreibung des vernünftigerweise vorhersehbaren Missbrauchs.
Der vernünftigerweise vorhersehbare Missbrauch eines aggressiven Reinigungsmittels könnte beispielsweise die Verwendung in einer Lebensmittelverarbeitungsumgebung sein.
Zu wenig auf die Beschreibung des vernünftigerweise vorhersehbaren Missbrauchs zu achten, wirkt sich auf die Haftung eines Unternehmens aus.,
Produkthaftungsgesetze / – vorschriften machen einen Hersteller für ein fehlerhaftes Produkt haftbar. Wenn die Fehlerhaftigkeit eines Produkts festgestellt werden muss, werden alle Umstände berücksichtigt. Dazu gehört auch die vernünftigerweise vorhersehbare Verwendung des Produkts.
Die Beschreibung des Verwendungszwecks bestimmt, welche Anweisungen im übrigen Handbuch enthalten sind. Wenn beispielsweise ein Kühlsystem nur zum Kühlen bestimmter Medikamente verwendet wird, müssen nur diese Verfahren beschrieben werden.,
Wenn vernünftigerweise davon ausgegangen werden kann, dass das Kühlsystem als System zur Kühlung von Organen verwendet werden kann, sollte dies in der Anleitung beschrieben werden. Auf diese Weise begrenzen Sie als Hersteller Ihre Haftung und Sie können sich darauf konzentrieren, nur zu beschreiben, wie Sie das System zur Kühlung von Arzneimitteln verwenden.
Aktion: Schreiben Sie den Verwendungszweck und den vernünftigerweise vorhersehbaren Missbrauch Ihres Produkts.
Abbildung 1. Vernünftigerweise vorhersehbarer Missbrauch?,
Schreiben Sie die Sicherheitswarnungen basierend auf der Risikoanalyse
Auch wenn der Verwendungszweck jetzt klar definiert wurde, bedeutet dies nicht, dass die Verwendung eines Produkts völlig ohne Risiken ist.
Um die mit der Verwendung eines Produkts verbundenen Gefahren zu identifizieren, können Sie eine Risikoanalyse durchführen. Eine Risikoanalyse kann auch für bestimmte Produktgruppen wie Niederspannungsgeräte, Spielzeug, Maschinen und Geräte für den Einsatz in explosionsgefährdeten Bereichen obligatorisch sein.
Es wurden Standards wie die ISO 12100 zur Durchführung einer Risikoanalyse entwickelt., Die ISO 12100 enthält auch eine Methode zur Durchführung von Minderungsmaßnahmen: die dreistufige Methode. Gemäß dieser Methode gibt es die folgende Hierarchie von risikomindernden Maßnahmen:
- Inhärent sichere Entwurfsmaßnahmen
- Schutzmaßnahmen und ergänzende Schutzmaßnahmen
- Informationen zur Verwendung
Dies bedeutet, dass das Benutzerhandbuch vor Restrisiken im Zusammenhang mit der Verwendung des Produkts warnen sollte. Dies geschieht mit Sicherheitswarnungen.,
JETZT KAUFEN
Eine gute Sicherheitswarnung beschreibt die Art einer Gefahrensituation, die Folgen der Nichtvermeidung einer Gefahrensituation und die Methode(en) zu ihrer Vermeidung.
Um den Grad der Gefahr anzuzeigen, auf die der Benutzer stoßen kann, sollten die Signalwörter „Gefahr“, „Warnung“ und „Vorsicht“ verwendet werden.
Sehen Sie sich die folgenden Sicherheitsmeldungen an:
WARNUNG! Rotierende Teile. Gefahr schwerer Verletzungen. Hände frei halten. Lockout/Tagout vor der Wartung.
Dann möchten Sie den Benutzer warnen, wo eine gefährliche Situation auftreten könnte. Die ANSI Z535.,6 standard beschreibt die folgenden Stellen im Benutzerhandbuch, an denen dies sein könnte:
- Gruppiert in einem separaten Kapitel.
- Im ersten Teil des spezifischen Abschnitts:
- Eingebettet in eine Prozedur:
1. Hierzu.
2. Mach das. WARNUNG! Dies sind eingebettete Sicherheitsmeldungen. Allgemeiner Text allgemeiner Text allgemeiner Text allgemeiner Text.
3. Hierzu.,
- Im Vorwort können alle ergänzenden Anweisungen platziert werden, z. B. Alle Anweisungen vor der Verwendung lesen oder diese Anweisungen für die zukünftige Verwendung in der Einführung eines Benutzerhandbuchs aufbewahren.
In der EU kann es je nach Art des Produkts erlaubt sein, nur die Sicherheitsinformationen in gedruckter Form und die übrigen Informationen online bereitzustellen.
Um Philip beim Erstellen und Platzieren einer Sicherheitsmeldung zu helfen, habe ich eine weitere Vorlage erstellt.
Aktion: Führen Sie eine Risikoanalyse durch und erstellen Sie Ihre Sicherheitsmeldungen mit dieser Vorlage.,
Erstelle alle anderen Inhalte
Jetzt habe ich Philip gebeten, alle anderen Inhalte wie Verfahren, technische Spezifikationen und rechtliche Informationen zu erstellen.
Ich habe folgende Tipps gegeben:
- Unnötiges Material ausschließen, um eine Informationsüberflutung zu vermeiden (z. B. Verkaufsförderung, umfangreiche Wiederholungen usw.).
- Stellen Sie sicher, dass Begriffe dem Benutzer vertraut sind, technische Merkmale und Begriffe gut erklärt sind und Begriffe konsistent verwenden.
- Beschreiben Sie alle Voraussetzungen, die erfüllt sein sollten, bevor die eigentlichen Anweisungen beginnen., Dies kann auch ein Spezialwerkzeug oder Platz für Wartung und Reparatur sein.
- Geben Sie konzeptionelle Informationen an, wenn Informationen für ein angemessenes Verständnis und die Ausführung von Aufgaben erforderlich sind.
- Schreibe immer themenbasiert.
- Verwenden Sie eine Fettschrift für alle Produktelemente.
- Verwenden Sie einen Styleguide, um die Dokumentation klarer zu schreiben und zu formatieren.
- Geben Sie an, wann Sie ein Bild hinzufügen möchten, um es später besser zu verstehen.
- Stellen Sie sicher, dass Wörter und Phrasen nicht zu kompliziert oder zu anspruchsvoll sind.,
- Verwenden Sie einfache/standardisierte und kurze Sätze: ein Satz-ein Befehl.
- Geben Sie nicht zu viele Informationen in einen Satz ein.
- Verwenden Sie die direkten aktiven Sprach-und Durchsetzungsbefehle.
- Verwenden Sie Wörter wie Substantive und Verben konsequent, um Mehrdeutigkeiten zu vermeiden.
- Um bessere Anweisungen zu schreiben, verwenden Sie die Prinzipien des Minimalismus in der technischen Kommunikation und vereinfachtes technisches Englisch.
Aktion: Erstellen Sie alle anderen Inhalte für Ihr Benutzerhandbuch.
Auch hier stehen für die meisten Produktgruppen kostenpflichtige Vorlagen zur Verfügung, die die Arbeit erleichtern könnten., Diese Vorlagen enthalten alle Rechtstexte, verpflichtende Entsorgungsinformationen, Urheberrechtserklärungen und entsprechen der Norm IEC 82079 auf Gebrauchsanweisung.
Platzieren Sie die Sicherheitswarnungen an der richtigen Position
Wenn Sie die Vorlage zum Erstellen der Sicherheitsnachrichten verwenden, habe ich Philip gebeten anzugeben, ob eine Sicherheitsnachricht eine zusätzliche Anweisung ist oder als gruppierte, abschnittsweise oder eingebettete Sicherheitsnachricht platziert werden soll.
Jetzt wurde der gesamte Text erstellt, die Sicherheitsmeldungen können an der richtigen Stelle platziert werden.,
Aktion: Platzieren Sie alle Sicherheitsmeldungen an der richtigen Stelle im Benutzerhandbuch.
Schritt 9 Fügen Sie Ihrer Benutzerhandbuchvorlage Navigation hinzu
Ein Benutzerhandbuch sollte Personen helfen, indem es Informationen zur Verwendung eines Produkts bereitstellt. Das Finden der richtigen Informationen, die das Problem des Benutzers lösen, sollte so wenig Zeit wie möglich in Anspruch nehmen.
Das Erstellen aussagekräftiger Überschriften ist eines der Werkzeuge, mit denen Benutzer Informationen finden können., Es gibt jedoch mehrere andere Tools, mit denen der Benutzer die gewünschten Informationen finden kann, z. B.:
- Inhaltsverzeichnis
- Seitennummerierung
- Index
Ich habe Philip gebeten, das Inhaltsverzeichnis zu aktualisieren und Seitennummerierung und einen Index hinzuzufügen.
Aktion: Fügen Sie Ihr Inhaltsverzeichnis, die Seitennummerierung und den Index hinzu oder aktualisieren Sie es.
Schritt 10 Lassen Sie Ihr Benutzerhandbuch überprüfen
Philip hat nun die Entwurfsversion seines Benutzerhandbuchs mithilfe der Benutzerhandbuchvorlage erstellt. Wir nennen diese version die textliche Gestaltung der Inhalte.,
Da Philip einen Geschäftspartner und einen Entwickler mit fundierten technischen Produktkenntnissen hat, bat ich Philip, ihnen die bisherige Arbeit zu überlassen.
Sowohl sein Geschäftspartner als auch der Entwickler gaben Feedback. Philip nutzte dieses Feedback, um das Benutzerhandbuch zu optimieren.
Aktion: Senden Sie die Entwurfsversion des Benutzerhandbuchs an alle in Ihrem Team, die möglicherweise Feedback geben können. Bitten Sie sie, alle Rückmeldungen in einem Dokument zu kombinieren, bevor Sie es an Sie zurücksenden. Dies regt die Diskussion Ihrer Teammitglieder an und verhindert später Meinungsverschiedenheiten.,
Schritt 11 Erstellen Sie die Bilder
Sobald das Benutzerhandbuch überprüft und optimiert wurde, sind die Texte mehr oder weniger eindeutig. Dies bedeutet, dass jetzt beliebige Bilder erstellt und dem Inhalt hinzugefügt werden können.
Der Grund, zu warten, bis die Texte fertig sind, ist, dass das Erstellen oder Bearbeiten von Bildern zeitaufwändig sein kann. Da Bilder Text unterstützen, ersetzen oder erweitern sollten, möchten Sie warten, bis die Texte endgültig sind.
Bilder in Benutzerhandbüchern können Illustrationen, Fotos, Screenshots, Tabellen, Diagramme und Schaltpläne enthalten.,
Es gibt viele großartige Tools, mit denen Sie Ihre Bilder erstellen können, z. B.:
- Snagit oder Adobe Photoshop zum Bearbeiten von Screenshots oder Fotos
- Solidworks Composer oder Google Sketchup zum Erstellen von Zeilenzeichnungen
- Lucidchart oder Microsoft Visio für Diagramme und Schaltpläne
Ich habe Philip geraten, Fotos nicht als günstige Alternative für Illustrationen. Oft sind Fotos nicht so informativ, weil sie zu viele Informationen enthalten. Außerdem können Fotos ein Benutzerhandbuch chaotisch aussehen lassen.,
Aus diesem Grund verwendete Philip Google Sketchup, um seine Illustrationen zu erstellen.
Aktion: Erstellen Sie die Bilder für Ihr Benutzerhandbuch.
Wenn Sie mehr über das Erstellen von Bildern erfahren möchten:
- Verwenden von Text, Bildern oder Videos
- Erstellen von IKEA-ish-Handbüchern
Schritt 12 Letzte Überprüfung der Benutzerhandbuchvorlage
Bevor wir damit beginnen, es schön aussehen zu lassen und den Inhalt zu übersetzen, möchten wir sicherstellen, dass der Inhalt vollständig ist.
Dazu habe ich Philip gebeten, eine Checkliste zu verwenden.,
Aktion: l Stellen Sie mithilfe dieser Checkliste sicher, dass Ihr Benutzerhandbuch alle relevanten Anforderungen der IEC 82079-1:2012 erfüllt.
Schritt 13 Entwerfen Sie Ihre Benutzerhandbuchvorlage
Ein gut gestaltetes Handbuch trägt zu einer besseren Marken-und Benutzererfahrung bei.
Sie können die Benutzerhandbuchvorlage in MS Word anpassen, indem Sie ein Firmenlogo hinzufügen und die Schriftart, Farben usw. anpassen.
Wenn Sie wissen, wie mit Adobe Indesign zu arbeiten, oder bereit sind, zu lernen, mit ihm zu arbeiten, wird dies Ihnen viel größere Gestaltungsmöglichkeiten bieten.,
Ich habe diese Vorlage in Indesign erstellt und Philip gebeten, sie an seine Markenidentität anzupassen.
Aktion: Passen Sie die Benutzerhandbuchvorlage an Ihre Markenidentität an oder laden Sie die InDesign-Benutzerhandbuchvorlage herunter und passen Sie sie an.
Schritt 14 DTP Works
DTP steht für Desktop Publishing und Wikipedia beschreibt es als „die Erstellung von Dokumenten mit Seitenlayout-Fähigkeiten auf einem PC in erster Linie für den Druck“.
Philip hat jetzt sowohl den Inhalt seines Benutzerhandbuchs (Word-Datei) als auch die Benutzerhandbuchvorlage (InDesign-Datei)., Der Inhalt muss in die InDesign-Vorlage. Dies wird Desktop Publishing genannt.
Aktion: Platzieren Sie den Inhalt Ihrer Word-Datei in der Indesign-Vorlage. Wenn Sie sich entschieden haben, die InDesign-Vorlage nicht zu verwenden, aber an der Word-Datei festhalten, können Sie diesen Schritt überspringen.
Schritt 15 Übersetzen und veröffentlichen Sie Ihre Benutzerhandbücher
Abhängig vom Markt, auf dem Sie Ihr Produkt verkaufen möchten, müssen Sie möglicherweise die Bedienungsanleitung übersetzen.
Einige allgemeine Tipps:
- Suchen Sie einen Übersetzer mit ähnlicher Erfahrung., Dies kann ein Übersetzer sein, der Erfahrung mit der Übersetzung technischer Inhalte, mit ähnlichen Produkten oder mit der Übersetzung von Benutzerhandbüchern hat.
- Wenn Sie in mehrere Sprachen übersetzen müssen, spart Ihnen die Arbeit mit einem Übersetzungsbüro möglicherweise viel Zeit.
- Fragen Sie den Übersetzer oder die Agentur nach ihren Qualitätsverfahren und wer wird den Text nach der Übersetzung überarbeiten.
- Da Sie Ihr Produkt am besten kennen und wer Ihr Publikum ist, ist es möglicherweise eine gute Idee, dem Übersetzer oder der Agentur ein Glossar oder eine Liste mit der Terminologie zur Verfügung zu stellen, die Sie verwenden möchten.,
- Suchen Sie nach einem Übersetzer, der direkt in Ihrer Word-oder InDesign-Datei arbeiten kann, oder suchen Sie eine Agentur, die auch die DTP-Arbeiten erledigt. Alternativ können Sie dies natürlich selbst tun.
Da Philip sein Produkt sowohl in den USA als auch in der EU verkaufen wird, beschloss er, mit einer Agentur zusammenzuarbeiten.
Aktion: Suchen Sie einen Übersetzer oder eine Agentur, die Ihren Bedürfnissen entspricht, und lassen Sie Ihr Benutzerhandbuch übersetzen.
Im Allgemeinen sollte ein Benutzerhandbuch in einem für den Benutzer leicht zugänglichen Format verfügbar sein. Das kann gedruckt oder online oder auf dem Gerät verwendet werden.,
Da ein Benutzer Informationen in dem Moment wünscht, in dem er sie benötigt und daher nicht in Kanälen denkt, wäre der beste Ansatz, die Anweisungen bereitzustellen Omni-Plattform.
In der Europäischen Union ist es für einige Produktgruppen immer noch beschränkt, das mit dem Produkt gedruckte Benutzerhandbuch bereitzustellen.
Ab April 2016 können die Anweisungen vieler Produktgruppen jedoch in einem anderen Format als in gedruckter Form geliefert werden. Es gibt jedoch eine Ausnahme.
Sicherheitsinformationen werden weiterhin zusammen mit dem Produkt in Papierform geliefert., Darüber hinaus sollte dem Verbraucher auf Anfrage eines Verbrauchers ein Benutzerhandbuch in Papierform zur Verfügung gestellt werden.
Philip entschied sich für Folgendes:
- Er stellt eine gedruckte vollständige Anleitung mit dem Produkt zur Verfügung, einschließlich der Sicherheitshinweise.
- Er erstellte eine separate Kurzanleitung, die auch mit dem Produkt geliefert werden sollte.
- Er stellte eine PDF-Version des vollständigen Handbuchs online.
- Er wird auf seiner Website einen Online-Hilfebereich mit der HTML-Version des Benutzerhandbuchs erstellen. Hier kann er auch Videos hinzufügen., Und durch die Optimierung der HTML-Version für Suchmaschinen erleichtert er es seinem Benutzer, Informationen für seinen Benutzer zu finden
Das ist alles. So habe ich mit Hilfe der Benutzerhandbuchvorlage und der anderen verfügbaren Tools, die ich bereitgestellt habe, ein konformes Benutzerhandbuch erstellt.
Das Beste an all dem ist, dass Sie die gleichen Ergebnisse erzielen können wie Philip, indem Sie diesem Schritt-für-Schritt-Prozess zum Erstellen eines Benutzerhandbuchs folgen.