Vorlage für die Erstellung einer Betriebsanleitung

Schritt 1 Grundsätzliches Wissen über die Vorlage zur Technischen Dokumentation

Bevor Sie die Vorlage zur Technischen Dokumentation und die anderen Tools, die ich für Philip entwickelt habe, tatsächlich anwenden, möchte ich dafür sorgen, dass wir den gleichen Ausgangspunkt haben. Ich habe ihm einige allgemeine Informationen zu Technischer Dokumentation, Benutzerhandbücher und anschauliche Beispiele existierender Handbücher gegeben.

Diese Informationen sind unten aufgelistet.

Wie lautet die Definition eines Handbuchs?

Ein Handbuch ist ein Dokument der Technischen Kommunikation, das Benutzern dabei helfen soll, ein Produkt zu benutzen. Ein gutes Handbuch unterstützt Benutzer ein Produkt sicher und effektiv zu nutzen.

Andere Bezeichnungen oder Arten von Handbüchern können sein:

• Anleitung
• Benutzerhandbuch
• Technische Dokumentation
• Benutzerhandbuch
• Betriebsanleitung
• Betriebsanweisung
• Handbuch
• Dokumentation
• Schulungshandbuch
• Kurzanleitung
• Installationsanleitung
• Wartungsanleitung
• Softwarehandbuch
• Montageanleitung

Neben dem wichtigsten Ziel eines Handbuchs (den Benutzern zu helfen), könnten sekundäre Ziele sein, für eine bessere Benutzererfahrung zu sorgen und rechtliche Vorgaben zu erfüllen.

Eine Technische Dokumentation besteht aus Text und visuellen Informationen (Illustrationen, Screenshots, Tabellen usw.), die den Benutzern helfen, bestimmte Aufgaben zu erledigen.

Die Benutzer stehen bei der Erstellung einer Technischen Dokumentation im Mittelpunkt. Eine gut durchdachte Technische Dokumentation stellt nur diejenigen Informationen zur Verfügung, die für die bestimmungsgemäße Verwendung des Produkts nötig sind.

Die Dokumentation sollte sowohl Informationen zu Prozessen (Schritt-für-Schritt-Anleitungen), als auch zu Konzepten (Informationen, die die Benutzer brauchen, um die Prozessinformationen zu verstehen) enthalten.

Ein gutes Handbuch ist prägnant und verwendet eine Sprache ohne Fachjargon. Ein gutes Handbuch sollte WIE- und WAS-Fragen beantworten. Es sollte Informationen dazu beinhalten, was zu tun ist, wenn eine Aufgabe nicht richtig durchgeführt wurde.

In manchen Fällen wird ein Produkt von verschiedenen Benutzertypen verwendet. Klassische Benutzertypen sind Endverbraucher, Installateure, Wartungsingenieure und Bediener. Jeder Typ verlangt nach einem eigenen Ansatz was die zu verwendende Sprache, den Tonfall und zugehörige Informationen anbetrifft.

Welche Informationen gehören in eine Technische Dokumentation?

Verschiedene Produkte brauchen eine Technische Dokumentation. Ein Produkt kann ein System, Werkzeug, Gerät, Instrument, eine Software, Maschine oder eine App sein. Je nach Produkttyp kann eine Technische Dokumentation folgendes enthalten:

• Vorwort
• Produktbezeichnung
• Modell oder Typnummer
• Bestimmungsgemäße Verwendung
• Eigenschaften/Ausstattung
• Beschreibung der Hauptproduktbestandteile
• Beschreibung der Benutzerschnittstelle
• Sicherheitshinweise
• Installationsanweisungen
• Beschreibungen, wie das Produkt zu benutzen/bedienen ist
• Fehlerbehebungsabschnitt und Anweisungen, wie Probleme behoben werden können
• Wartungsanweisungen
• Reparaturhinweise
• Informationen zur Entsorgung des Produkts und dessen Verpackung
• Technische Daten
• Inhaltsverzeichnis
• Index
• Glossar
• Garantiehinweise
• Kontaktangaben

Anwendung einer Vorlage für Technische Dokumentationen

Das Haupt-Tool, das ich entwickelt habe, damit Philip sein Handbuch schreiben kann, ist eine Vorlage für Technische Dokumentationen. Die Vorlage für die Verfassung eines Handbuchs enthält alle Informationen aus der Liste oben und noch mehr. Sie entspricht den Anforderungen für dieses Produkt.

Die Vorlage kann für Ihre Systeme, Werkzeuge, Geräte und Instrumente genutzt werden oder um Installationsanleitungen, Softwarehandbücher, Gebrauchsanleitungen, Benutzerhandbüchern, Wartungsanleitungen, Betriebsanweisungen oder Schulungshandbücher zu erstellen.

Auf Grundlage der ersten Vorlage für Philip haben wir Vorlagen für die folgenden Produktgruppen entwickelt:

• Medizinprodukte
• Maschinen (Gebrauchsanleitungsmuster nach der Maschinenrichtlinie)
• Elektronik

Welches Format hat eine Technische Dokumentation?

Eine Handbuch kann entweder in Papierform oder als elektronisches Dokument vorliegen (als PDF, online oder in HTML-Format auf einem Gerät). Das Muster für die Technische Dokumentation ist ein MS Word-Vorlage, das ausgedruckt oder online platziert werden kann.

Gebrauchsanleitungen oder Handbücher können mit verschiedenen Tools erstellt werden. Jedes Tool hat seine eigenen Vor- und Nachteile. Ich werde die gängigsten Tools unten aufzählen:

	Vorteile	Nachteile
Word	Einfach zu erlernen Betriebshandbuch Vorlage Word kann einfach eingerichtet werden	Weniger geeignet für große Dokumente Keine Wiederverwendung von Inhalten möglich
Indesign	Hohes Maß an Gestaltungsfreiheit	Änderungen am Inhalt können viele zusätzliche DTP Stunden erforderlich machen
CMS (technische Redakteure & Herausgabe Lösungen)	Wiederverwendung der Inhalte All in one Lösung Omni-Plattform Veröffentlichung Enthält Benutzerhandbuchvorlagen	High learning curve

Schritt 2 Bestimmen Sie die Zielgruppe Ihres Handbuchs

Ok, Philip weiß jetzt etwas über Technische Dokumentationen. Widmen wir uns jetzt also den Details und Aufgaben.

Wenn Sie eine Dokumentation schreiben wollen, die Ihren Benutzern hilft, Probleme zu lösen, sollten Sie als erstes klären, wer Ihre Benutzer sind. Das schaffen Sie, indem Sie ein Benutzerprofil, eine Persona, erstellen.

Eine Persona ermöglicht es Ihnen, sinnvolle Annahmen über die Eigenschaften Ihrer Benutzer zusammenzutragen. Das hilft Ihnen nicht nur bei der Erstellung Ihrer Technischen Dokumentation, sondern ist ein grundlegender Meilenstein am Beginn einer Produktentwicklung! Als gelernter Ingenieur für Industriedesign habe ich so alle meine Designaufträge begonnen.

Als ich mir die Homepage von dem Portara angesehen habe, habe ich nicht einmal eine eindeutige Beschreibung der vorgesehenen Anwender gefunden. Darum habe ich Philip gebeten, seine Benutzer zu beschreiben und mir Fragen wie diese zu beantworten:

• Wer benutzt Dein Produkt?
• Wird das Produkt professionell oder hauptsächlich privat genutzt?
• Welches technische Wissen haben die Benutzer? Wie können die Benutzer beschrieben werden?

Ich habe ein Muster erstellt, die diese Fragen beinhaltet. Und ich habe Philip gebeten, diese Vorlage auszufüllen.

Sie können die Vorlage nutzen, um herauszufinden, wer Ihre Benutzer sind. Die zweite Seite beinhaltet auch Philips Antworten, dadurch haben Sie eine Vorstellung, wie die Vorlage genutzt werden könnte.

Aufgabe: Füllen Sie die Vorlage aus, um Ihre Benutzer zu beschreiben.

Ich bin ein RIESIGER Fan von Visualisierungen. Wenn Sie in der Beschreibung Ihrer Benutzer also noch einen Schritt weiter gehen möchten, würde ich Ihnen Vorschlagen, Ihre Benutzer in Form einer Persona zu visualisieren. Dabei geben Sie der Persona einen Namen, ein Alter usw., damit daraus eine echte Person wird, die Ihre Benutzer repräsentiert.

Aufgabe: Eine Visualisierung Ihrer Benutzer erstellen

Wenn Sie mehr über die Definierung ihres Zielpublikums und die Erstellung von Personas erfahren möchten:

• https://www.nngroup.com/articles/persona/
• https://www.astauthors.co.uk/aboutast/articles/determiningyouraudience.php
• https://www.smashingmagazine.com/2014/08/a-closer-look-at-personas-part-1/
• https://www.prismnet.com/~hcexres/textbook/aud.html

Schritt 3 Entwickeln Sie Themen für die Probleme Ihrer Nutzer

Beginnen Sie mit einer Definition der Probleme, denen Ihre Benutzer während des Lebenszyklus des Produkts begegnen könnten und die Sie lösen möchten. Typische Problemfelder könnten sein: die Installation des Produkts, dessen Verwendung, das Produkt sicher zu verwenden, die Wartung und Entsorgung des Produkts.

Wenn das Problem zu komplex ist, sollten Sie es in kleine Teile, Chunks, aufteilen.

Ich habe Philip gebeten, die Probleme und Lösungen zu beschreiben, denen seine Nutzer über den Lebenszyklus seiner Maschine gegenüberstehen könnten. Dafür habe ich eine weitere Vorlage für ihn erstellt. In der linken Zeile der Lifecycle Vorlage sind die Stadien eines Produktlebenszyklus beschrieben. Diese sind aus dem internationalen Standard für Gebrauchsanweisungen IEC/IEEE 82079 entnommen. Eine Betriebsanleitung Vorlage von INSTRKTIV für Gebrauchsanleitungen und Handbücher entspricht dieser Norm.

Aufgabe: Verwenden Sie diese Vorlage und die Anweisungen aus der ersten Seite, um die Probleme, die Ihre Nutzer im Laufe des Lebenszyklus Ihres Produktes haben könnten zu identifizieren und Lösungen anzubieten.

Wenn Sie mehr über die Definierung möglicher Probleme Ihrer Nutzer und zur Themenerstellung erfahren möchten:

• Topic based authoring
• Minimalismus
• Informationmapping
• Chunking

Schritt 4 Definieren Sie die Struktur der Vorlage zum Benutzerhandbuch

Philip hat nun definiert, welche Probleme seine Nutzer im Laufe des Lebenszyklus seines Produkts haben könnten und er hat sich eine Lösung dieser Probleme ausgedacht. Mit anderen Worten: Philip hat die Themen für sein Benutzerhandbuch. Jedes Thema kann nur von einem bestimmten Gegenstand handeln, es hat einen erkennbaren Zweck und muss auch eigenständig funktionieren.

Ein Thema sollte die Antwort auf nur eine einzige Frage der Benutzer geben. Benutzer wollen ein Problem nach dem anderen lösen. Wenn ein Problem gelöst ist, wird sich der Benutzer dem nächsten widmen.

Ein Thema wird ein Abschnitt in der Technischen Dokumentation sein. Es kann ein Kapitel oder (Unter-)Absatz sein. Sobald ein Benutzer nach einer Lösung für sein Problem sucht, wird er das Inhaltsverzeichnis konsultieren und herausfinden, wie er zu dieser Antwort gelangt.

Ich bat Philip, die Themen zu strukturieren und ihren Platz im Benutzerhandbuch zu bestimmen, indem er ein bestimmtes Thema einem bestimmten Kapitel oder (Unter-)Absatz zuordnet.

Aufgabe: Die Struktur Ihrer Technischen Dokumentation festlegen in dieser Vorlage:

1. Kopieren Sie den Inhalt aus der Seite Lebenszyklus [Produktname] in die Seite Inhaltsverzeichnis [Produktname]. 
2. Ersetzen Sie auf der Seite Inhaltsverzeichnis [Produktname] den Produktnamen mit dem Namen Ihres eigenen Produkts.
3. Fügen Sie eine Spalte auf der Linken Seite hinzu. Nennen Sie sie „Abschnitt“.
4. Ordnen Sie Ihre Abschnitte gegebenenfalls in logischer Reihenfolge.
5. Bestimmen Sie, welche Themen zu Kapiteln werden, indem Sie ihnen Kapitelnummern verleihen. Geben Sie dem Kapitel PREPARATION PRODUCT FOR USE (Inbetriebnahme) die Nummer 4. Wir werden im nächsten Schritt mehr Kapitel hinzufügen.
6. Bestimmen Sie, welche Themen zu Abschnitten werden, indem Sie ihnen Abschnittsnummern verleihen.
7. Bestimmen Sie, welche Themen zu Unterabschnitten werden, indem Sie die Nummern der Unterabschnitte hinzufügen.

Jetzt haben Sie das Inhaltsverzeichnis erstellt. Das Inhaltsverzeichnis ist die Gliederung Ihrer Technischen Dokumentation. Wir werden später weitere Kapitel/Abschnitte hinzufügen, z. B. die Einleitung, Sicherheitshinweise etc. Darüber müssen Sie sich jetzt noch keine Gedanken machen.

Schritt 5 Aussagekräftige Überschriften erstellen

Jedes Thema des Handbuchs erhält seine eigene Überschrift. Die Überschriften sind die (Unter-)Titel, die dem eigentlichen Text vorausgehen. Sie erscheinen im Inhaltsverzeichnis, damit die Benutzer zur benötigten Information blättern können.

Philip hat gerade die (Unter-)Titel seiner Themen erstellt.

Die Einträge im Inhaltsverzeichnis sind wichtig, damit Ihre Nutzer finden, wonach sie suchen und überspringen können, wonach sie NICHT suchen. Daher benötigen sie etwas mehr Aufmerksamkeit.

Grundsätzlich sollten Sie versuchen mit drei Eben an Überschriften zu arbeiten: Überschriften der ersten, zweiten und dritten Ebene.

Überschriften der ersten Ebene beschreiben den Inhalt des gesamten Kapitels oder Abschnitts (z. B. INBETRIEBNAHME). Überschriften der zweiten Ebene sollten im „Wie-Was-Stil“ formuliert werden (z. B. Wie das Produkt zusammengebaut wird und Wie die elektrische Installation durchgeführt wird). Auf der dritten Eben werden Nominalsätze verwendet (z. B. Verpackungsinhalt und Zu verwendende Werkzeuge).

Ich habe Philip gebeten, seine Überschriften umzuleiten und dabei die folgenden Grundregeln zu beachten:

• Folgen Sie der oben angegeben Struktur von Überschriften erster, zweiter und dritter Ebene.
• Achten Sie darauf, dass die Überschriften selbsterklärend sind. Die Überschrift Pfannkuchen zubereiten ist viel nutzerorientierter als Den MagicCook5000 verwenden.
• Achten Sie darauf, dass die Überschrift das gesamte Thema abdeckt. Behandelt der Abschnitt Wartung und Reparatur eines Produkts, wäre die Überschrift Wartung unzureichend.
• Wenn möglich, vermeiden Sie Artikel am Beginn der Überschriften.

Aufgabe: Formulieren Sie neue Überschriften für Ihr Inhaltsverzeichnis.

Ein Muster mit aussagekräftigen Überschriften kann im Inhaltsverzeichnis gefunden werden.

Schritt 6 Festlegung der rechtlichen Inhalte

Je nach Markt, auf dem Ihr Produkt platziert ist oder verwendet wird und abhängig von der Produktklasse, zu der Ihr Produkt gehört, gelten spezielle Rechtsprechungen für ihr Produkt.

Grundsätzlich verlangt die Rechtsprechung, dass Ihr Produkt „sicher“ ist und gibt daher allgemeine Sicherheitsanforderungen an, denen Ihr Produkt entsprechen sollte.

Diese Anforderungen umfassen auch Anforderungen an den Inhalt Ihrer Bedienungsanweisung und Ihrer Sicherheitshinweise.

Um Ihr Produkt auf einem bestimmten Markt verkaufen zu können, sollten Sie sicherstellen, dass Ihre Technische Dokumentation diesen Anforderungen entspricht.

Diese beiden Artikel zeigen Ihnen, wie Sie genau feststellen können, welche Rechtsvorschriften für Ihr Produkt auf dem europäischen und US-amerikanischen Markt gelten und was die Anforderungen an Ihres Handbuchs sind. Profitipp: gibt es bereits eine Konformitätserklärung, können Sie die gültigen Richtlinien darin finden.

• Wie Sie rechtskonforme Technische Dokumentation schreiben (für die EU)
• Wie Sie rechtskonforme Technische Dokumentation erstellen(für die USA)

Philip musste diesen Schritt nicht durchführen, da die verlangten rechtlichen Inhalte bereits in seiner Vorlage enthalten waren.

Für die Betriebsanleitung seines Produkts werden die folgenden Informationen verlangt:

EU (relevante CE-Kennzeichnungsrichtlinien: LVD, EMC, RoHS, WEEE, REACH):

• Die Technische Dokumentation sollte in die Sprachen der Länder übersetzt werden, in denen das Produkt verkauft wird.
• Gebrauchsanweisungen und Handbücher sollten eine Beschreibung des Verwendungszwecks des Produkts enthalten.
• Die Technische Dokumentation sollte eine Beschreibung der vernünftigerweise vorhersehbaren Fehlanwendung des Produkts beinhalten.
• Gegebenenfalls sollte eine Nichteinhaltung in Wohngebieten erwähnt werden.
• Die Typ, Batch- oder Seriennummer oder ein anderes Element, das die Identifikation des Produkts ermöglicht, sollte auf dem Produkt angegeben sein. Ist das Produkt dazu zu klein, kann es in der Technischen Dokumentation angegeben werden.
• Der Name, eingetragene Handelsname oder das eingetragene Warenzeichen und die Postadresse sollten auf dem Produkt angegeben werden. Ist das Produkt dazu zu klein, kann es in der Technischen Dokumentation angegeben werden.
• Es sollte eine Risikoanalyse durchgeführt werden, um die Restrisiken in Verbindung mit der Verwendung des Produkts zu bestimmen. Sicherheitsinformationen sollten zur Verfügung gestellt werden, damit die Nutzer wissen, was zu tun ist.
• WEEE-Informationen müssen beigefügt werden
• Informationen zu Verpackungsabfällen müssen enthalten sein.
• Die Anforderungen einer Betriebsanleiting für Maschinen gem. der Maschinenrichtlinie.

Neben diesen Gesetzen gibt es auch einen internationalen Standard für Gebrauchsanweisungen, den IEC/IEEE 82079-1:2019 und einen für Gebrauchsanleitungen für Maschinen, den DIN EN ISO 20607. Dieser Standard wurde für die EU harmonisiert. Die Einhaltung harmonisierter Standards führt bereits zu einer Konformitätsvermutung mit den entsprechenden Rechtsvorschriften!

Eine Betriebsanleitung Vorlage und die Handbücher von INSTRKTIV entsprechen dieser Norm.

Dazu habe ich eine IEC/IEEE 82079-Checkliste erstellt, mit der Sie überprüfen können, ob Ihre Anleitung mit diesem Standard konform ist.

Um eine international konforme Technische Dokumentation zu erstellen, sollten Sie stets darauf achten, dass Ihre Dokumentation die Anforderungen der EU, USA und dem 82079-Standard entsprechen.

Aufgabe: Um die rechtlichen Anforderungen an Ihr Handbuch zu ermitteln:

1. Führen Sie Schritt 1-2 des EU-Konformitätsartikels und/oder Schritt 1-6 des US-Konformitätsartikels durch, um den rechtlichen Rahmen Ihrer Technischen Dokumentation festzulegen.
2. Gehen Sie die IEC/IEEE 82079-Checkliste durch, um sicherzustellen, dass Ihr Handbuch dem 82079-Standard entspricht.

Diese Videos zeigen Ihnen, wie Sie die rechtlichen Anforderungen für Ihre Elektrogeräte/Ihre Machinen/Medizinprodukte bestimmen:

HIER KAUFEN

Schritt 7 Herunterladen und Vorbereiten der Vorlage für das Handbuch

Jetzt kann Philip damit beginnen, seine eigentliche Betriebsanweisung zu verfassen. 

Ich habe ihn gebeten, das Inhaltsverzeichnis in der Vorlage entsprechend seinem eigenen Inhaltsverzeichnis anzupassen. Natürlich ohne dabei etwaige obligatorischen Elemente zu löschen... 

Erinnern Sie sich an Schritt 4, als ich sagte, die Nummerierung der Abschnitte sollte mit Kapitel 4 beginnen? Wenn Sie die Vorlage selbst heruntergeladen haben, werden Sie sehen, dass bereits einige Standardkapitel sowie Anhänge hinzugefügt wurden.

Aufgabe: Die Vorlage anpassen:

Wenn Sie mit der Gratisvorlage arbeiten möchten:

1. Laden Sie die Gratisvorlage für Word 2013 oder 2007 herunter
2. Ändern Sie die Kapitelüberschriften gemäß Ihrem eigenen Inhaltsverzeichnis. Hinweis!  Verändern Sie nicht das eigentliche Inhaltsverzeichnis. Das Inhaltsverzeichnis kann automatisch aktualisiert werden, sobald die Kapitelüberschriften geändert wurden.
3. Fügen Sie die in Schritt 6 festgelegten notwendigen Inhalte Ihrer Technischen Dokumentation hinzu.
4. Passen Sie gegebenenfalls die Abschnitte 1-3 und die Anhänge Ihren eigenen Bedürfnissen an.

Oder verwenden Sie, wie Philip, unser kostenpflichtiges Muster mit allen notwendigen Inhalten.

Schritt 8 Schreiben Sie die Inhalte Ihrer Technischen Dokumentation

Formulieren Sie die bestimmungsgemäße Verwendung

Der Zweck Ihres Produkts, oder vielmehr: die bestimmungsgemäße Verwendung ist das Herzstück eines Handbuchs und bildet die Grundlage der sicheren und gefahrfreien Verwendung des Produkts.

Die Formulierung der bestimmungsgemäßen Verwendung formuliert darüber hinaus ihre Haftung und wirkt sich auf die weiteren Inhalte Ihrer Technischen Dokumentation aus.

Die meisten EU-Richtlinien und -Verordnungen schreiben eine Beschreibung der bestimmungsgemäßen Verwendung in der Technischen Dokumentation vor.

Der internationale Standard für Gebrauchsanweisungen IEC 82079-1 gibt die folgende Definition der bestimmungsgemäße Verwendung vor:

Umfassenden Funktionsumfang oder vorgesehene Anwendungen, die vom Anbieter des Produkts definiert und konzipiert wurden

Die Beschreibung der bestimmungsgemäßen Verwendung ist der Sicherheitsrahmen Ihres Produkts. Und sobald Sie die bestimmungsgemäße Verwendung ermittelt haben, können Sie sich auf die Sicherheits- und Benutzeranweisungen für die Verwendung ihres Produkts innerhalb dieses Rahmens konzentrieren.

Zusätzlich zur bestimmungsgemäßen Verwendung verlangen viele Standards, Richtlinien und Bestimmungen, dass Sie eine Beschreibung der vernünftigerweise vorhersehbaren Fehlanwendung des Produkts einfügen.

Z. B. könnte eine vernünftigerweise vorhersehbare Fehlanwendung eines aggressiven Reinigungsmittels dessen Anwendung in der Lebensmittelindustrie sein.

Schenken Sie der Beschreibung der vernünftigerweise vorhersehbare Fehlanwendung zu wenig Aufmerksamkeit, wird sich das auf die Haftung Ihres Unternehmens niederschlagen.

Gesetze/Bestimmungen zur Produkthaftung machen den Hersteller haftbar für ein defektes Produkt. Muss der Fehler eines Produkts bestimmt werden, werden alle möglichen Situationen in Betracht gezogen. Inklusive der vernünftigerweise vorhersehbare Fehlanwendung des Produkts.

Die Beschreibung der bestimmungsgemäßen Verwendung legt fest, welche Anweisungen in der restlichen Technischen Dokumentation gegeben werden. Wenn z. B. ein Kühlsystem nur für die Kühlung bestimmter Medikamente vorgesehen ist, müssen nur die damit zusammenhängenden Prozesse beschrieben werden.

Wenn es vernünftigerweise vorhersehbar wäre, dass damit auch Organe gekühlt werden, sollte die auch in den Anweisungen beschrieben werden. So können Sie als Hersteller Ihre Haftung in Grenzen halten und sich darauf konzentrieren, zu beschreiben, wie das Kühlsystem zur Kühlung von Medikamenten genutzt wird.

Aufgabe: Formulieren Sie die bestimmungsgemäße Verwendung und die vernünftigerweise vorhersehbare Fehlanwendung Ihres Produkts.

Vernünftigerweise vorhersehbare Fehlanwendung?

Formulieren Sie die Sicherheitshinweise auf Grundlage der Risikoanalyse

Obwohl die bestimmungsgemäße Verwendung nun klar definiert wurde, bedeutet das nicht, dass die Verwendung eines Produkts jetzt vollkommen ungefährlich ist.

Um die Risiken bei der Verwendung des Produkts zu ermitteln, können Sie eine Risikoanalyse durchführen. Für manche Produktgruppen kann eine Risikoanalyse auch vorgeschrieben sein, wie z. B. für Niederspannungsgeräte, Spielzeuge, Maschinen und Geräte, die in explosionsfähigen Atmosphären verwendet werden.

Standards, wie der ISO 12100 wurden für die Durchführung solcher Risikoanalysen entwickelt. Der ISO 120100 bietet auch Methoden für abmildernde Maßnahmen an: die Drei-Schritte-Methode. Laut dieser Methode, gibt es die folgende Hierarchie risikominimierender Maßnahmen:

1. Sichere Maßnahmen zur Integration der Sicherheit bei der Konstruktion
2. Absicherung und zusätzliche Schutzmaßnahmen
3. Gebrauchsanweisungen

D. h., dass das Handbuch vor allen Restrisiken in Verbindung mit der Verwendung des Produkts warnen sollte. Das wird mithilfe von Sicherheitshinweisen getan.

Ein guter Sicherheitshinweis beschreibt die gefährliche Situation, die Konsequenzen, wenn die Situation nicht vermieden wird und die Methoden, um sie zu verhindern.

Um die Schwere der möglichen Gefahr für die Benutzer zu verdeutlichen, werden die Signalwörter „Gefahr“, „Warnung“ und „Vorsicht“ verwendet.

Sehen Sie sich die folgenden Sicherheitshinweise an:

WARNUNG! Rotierende Bauteile. Risiko schwerwiegender Verletzungen. Nicht in den Arbeitsbereich greifen. Vor der Wartung Lockout/Tagout (Verriegelung/Kennzeichnung) einhalten.

Dann möchten Sie Ihre Benutzer vor gefährlichen Situationen warnen. Der ANSI Z535.6-Standard beschreibt im Folgenden die Abschnitte im Handbuch, an denen die Warnungen platziert werden könnten:

• Zusammengefasst in einem separaten Kapitel.
• Im ersten Teil des jeweiligen Kapitels:
  

• Eingebettet in eine Anweisung:

1. Tun Sie dies.

2. Tun Sie jenes. WARNUNG! Dies ist der eingebettete Sicherheitshinweis. Text Text Text Text Text.

3. Tun Sie dies.

• Jegliche zusätzliche Anweisungen können in der Einleitung einer Technischen Dokumentation erwähnt werden, wie Lesen Sie alle Anweisungen, bevor Sie das Produkt verwenden oder Bewahren Sie diese Anweisungen für spätere Konsultationen auf.

Je nach Produkt kann es in der EU erlaubt sein, nur die Sicherheitshinweise in Papierform zur Verfügung stellen zu müssen und den Rest der Informationen online anzubieten.

Um Philip zu helfen, Sicherheitshinweise zu erstellen und platzieren, habe ich eine weitere Vorlage erstellt.

Aufgabe: führen Sie eine Risikoanalyse durch und erstellen Sie ihre Sicherheitshinweise mithilfe dieser Vorlage.

Erstellung der restlichen Inhalte

Jetzt habe ich Philip gebeten, die restlichen Inhalte zu erstellen, wie Abläufe, technische Spezifikationen und rechtliche Informationen.

Dazu habe ich folgende Tipps: 

• Vermeiden Sie unnötiges Material, um eine Informationsflut zu vermeiden (z. B. Werbung, extensive Wiederholungen usw.).
• Achten Sie darauf, dass die verwendeten Begriffe den Lesern bekannt sind, technische Aspekte und Termini gut erklärt und konsistent verwendet werden.
• Erläutern Sie alle Voraussetzungen, die vor den eigentlichen Betriebsanweisungen getroffen werden müssen. Das kann auch Hinweise auf spezielle Werkzeuge oder ausreichend Platz für Wartungs- und Reparaturarbeiten umfassen.
• Bieten Sie beschreibende Informationen, wenn dies zum hinreichenden Verständnis und der Ausführung einer Aufgabe notwendig ist.
• Schreiben Sie immer themenbasiert.
• Schreiben Sie alle Produktbestandteile fett.
• Markieren Sie, wo Sie später ein Bild zum besseren Verständnis einführen möchten.
• Achten Sie darauf, dass Wörter und Sätze nicht zu kompliziert oder hochgestochen sind.
• Verwenden Sie einfache/standardisierte und kurze Sätze: ein Satz-eine Anweisung.
• Packen Sie nicht zu viel Information in einen Satz.
• Verwenden Sie aktive Formulierungen und bestimmende Anweisungen.
• Verwenden Sie Substantive und Verben konsistent, um Mehrdeutigkeiten zu vermeiden.
• Um bessere Dokumentation zu schreiben, folgen Sie den Prinzipien des Minimalismus in der Technischen Kommunikation und Simplified Technical English.

Aufgabe: Erstellen Sie die restlichen Inhalte Ihrer Technischen Dokumentation.

Nochmal: Für die meisten Produktgruppen gibt es kostenpflichtige Vorlagen, die Ihnen die Arbeit erleichtern können. Diese Betriebsanweisungen Vorlagen enthalten bereits alle rechtlichen Texte, verpflichtenden Entsorgungshinweise, urheberrechtlichen Erklärungen und sie sind konform mit dem IEC 82079-Standard für Gebrauchsanweisungen.

Richtige Positionierung der Sicherheitshinweise

Ich habe Philip bei der Verwendung der Vorlage für die Sicherheitshinweise gebeten zu markieren, ob die Sicherheitshinweise als ergänzende Instruktionen oder zusammengefasst, vor einem Kapitel oder eingebettet platziert werden sollen.

Jetzt ist der gesamte Text erstellt, die Sicherheitshinweise können an der richtigen Stelle eingefügt werden.

Aufgabe: Platzieren Sie alle Sicherheitshinweise in Ihrem Handbuch an der richtigen Stelle.

Schritt 9 Navigation Ihres Handbuchs

Ein Handbuch sollte Nutzer unterstützen, indem Informationen zur Verwendung eines Produkts geboten werden. Die Suche nach den richtigen Informationen zur Lösung eines Problems sollte die Benutzer so wenig Zeit wie möglich kosten.

Das Erstellen aussagekräftiger Überschriften ist eines der Hilfsmittel, das Benutzer auf der Suche nach der richtigen Information unterstützen kann. Es gibt jedoch noch viele weitere Hilfsmittel, die den Nutzern bei der Suche helfen können:

• Das Inhaltsverzeichnis
• Seitenzahlen
• Index

Ich habe Philip gebeten, sein Inhaltsverzeichnis zu aktualisieren und Seitenzahlen sowie einen Index hinzuzufügen.

Aufgabe: Aktualisieren oder erstellen Sie Ihr Inhaltsverzeichnis, Seitenzahlen und einen Index.

Schritt 10 Lassen Sie Ihr Benutzerhandbuch überprüfen

Philip hat nun die Betriebsanleitung Vorlage verwendet, um die Rohfassung seiner Anleitung zu verfassen. Diese Version nennen wir das textual content design (Text-Inhalt-Entwurf).

Da Philip einen Geschäftspartner und einen Entwickler mit tiefgreifendem technischem Wissen zum Produkt hat, haben ich ihn gebeten ihnen die Rohfassung zum Korrekturlesen zu geben.

Von beiden hat Philip Feedback bekommen. Dieses Feedback hat Philip genutzt, um das Benutzerhandbuch zu verbessern. 

Aufgabe: Schicken Sie Ihre Rohfassung der Technischen Dokumentation an jeden in Ihrem Team, der Ihnen dazu Feedback geben könnte. Bitten Sie alle, jede Rückmeldung in einem Dokument zu sammeln, bevor sie sie zurückschicken. Das regt Ihr Team zum Austausch an und beugt späteren Unstimmigkeiten vor.

Schritt 11 Erstellung der Bilder

Sobald das Handbuch Korrektur gelesen und verbessert wurde, sind die Texte mehr oder weniger fertig. D. h., dass jetzt jegliche Bilder erstellt und dem Text hinzugefügt werden können.

Der Grund dafür, warum man warten sollte, bis die Texte fertiggestellt sind ist, dass die Erstellung oder Bearbeitung von Bildern sehr viel Zeit in Anspruch nehmen kann. Da Bilder den Text unterstützen, ersetzen oder ergänzen sollen, warten Sie lieber, bis diese Texte fertig sind.

Bilder in einer Technischen Dokumentation können Illustrationen, Fotos, Screenshots, Tabellen, Diagramme oder Schaubilder sein.

Es gibt viele tolle Tools, die Ihnen bei der Erstellung solcher Bilder helfen können.

• Snagit oder Adobe Photoshop zur Bearbeitung von Screenshots oder Fotos
• Solidworks Composer oder Google Sketchup zur Erstellung von Strichzeichnungen
• Lucidchart oder Microsoft Visio für Diagramme und Schaubilder

Ich habe Philip geraten, nicht Fotos als billige Alternative für Illustrationen einzusetzen. Fotos sind oft nicht so aussagekräftig, da sie zu viele Informationen enthalten. Darüber hinaus können Fotos ein Handbuch unstrukturiert wirken lassen.

Daher hat Philip Google Sketchup zur Erstellung seiner Illustrationen verwendet.

Aufgabe: Kreieren Sie die Bilder für Ihr Handbuch oder Ihren Leitfaden.

Schritt 12 Endabnahme des Benutzerhandbuchs

Bevor wir damit beginnen, das Handbuch aufzupolieren und es zu Übersetzen, sollten wir sichergehen, dass es vollständig ist.

Dafür habe ich Philip gebeten, eine Checkliste zu verwenden.

Aufgabe: Mit dieser Checkliste stelle ich sicher, dass Ihre Gebrauchsanleitungen oder Handbücher alle relevanten Bedingungen der EN IEC/IEEE 82079-1 erfüllen.

Schritt 13 Das Design Ihrer Technischen Dokumentation

Eine Technische Dokumentation mit gutem Design kann die Marke unterstützen und für ein besseres Kundenerlebnis sorgen.

Wie dieses Benutzerhandbuch, das wir für AEG/Electrolux erstellt haben?

Wie diese Kurzanleitung für LIDL?

Wie dieses Handbuch für Gazelle?

Oder dieses Beispiel?

Sie können das Handbuch in MS Word bearbeiten, indem Sie ein Firmenlogo hinzufügen und die Schrift, Farben etc. anpassen. Dabei können Sie jedoch an Grenzen stoßen.

Wenn Sie mit Adobe InDesign umgehen können, oder bereit sind, es zu lernen, eröffnet Ihnen dies viel mehr Designoptionen und könnten Sie Anleitungen wie die Beispiele erstellen.

Aufgabe: Passen Sie die MS Word Vorlage and Ihrer Marke an, oder erstellen Sie eine InDesign-Vorlage.

Schritt 14 Desktop Publishing

DTP steht für Desktop Publishing und Wikipedia beschreibt es als den ‘rechnergestützte(n) Satz von Dokumenten, die aus Texten und Bildern bestehen und später als Publikationen ihre Verwendung finden, wie zum Beispiel Bücher, Broschüren, Magazine oder Kataloge’.

Philip hat jetzt beides, den Inhalt seiner Betriebsanleitung (Word-Dokument) und eine InDesign Vorlage für Technische Dokumentationen. Der Inhalt muss in die InDesign-Vorlage kopiert werden. Das nennt man Desktop Publishing.

Aufgabe: Kopieren Sie den Inhalt aus Ihrem Word-Dokument in die InDesign-Vorlage. Falls Sie sich entschieden haben, die InDesign-Vorlage nicht zu nutzen und bei Ihrem Word-Dokument zu bleiben, können Sie diesen Schritt überspringen.

Schritt 15 Übersetzung und Veröffentlichung Ihrer Technischen Dokumentation

Je nachdem, auf welchem Markt Sie Ihre Produkte verkaufen möchten, kann es sein, dass Sie Ihre Gebrauchsanleitungen übersetzen müssen.

Einige allgemeine Hinweise:

• Suchen Sie sich einen Übersetzer mit einschlägiger Erfahrung. Das könnte ein Übersetzer mit Erfahrung im Übersetzen von technischen Inhalten, ähnlichen Produkten oder Technischen Dokumentationen sein.
• Wenn Sie in mehrere Sprachen übersetzen müssen, können Sie viel Zeit sparen, indem Sie mit einer Übersetzungsagentur zusammenarbeiten.
• Erkundigen Sie sich beim Übersetzer oder der Agentur nach deren Qualitätssicherungsmaßnahmen und wer den Text nach der Übersetzung Korrektur lesen wird.
• Da Sie Ihr Produkt am besten kennen, kann es hilfreich sein, wenn Sie dem Übersetzer oder der Agentur ein Glossar oder eine Liste mit wichtiger Terminologie übermitteln.
• Suchen Sie einen Übersetzer, der direkt in Word oder InDesign arbeiten kann oder finden Sie eine Agentur, die das DTP für Sie übernimmt. Alternativ können Sie das natürlich auch selbst erledigen.

Da Philip sein Produkt sowohl in den USA als auch in der EU verkaufen möchte, hat er sich entschlossen, mit einer Agentur zusammenzuarbeiten.

Aufgabe: Finden Sie einen Übersetzer oder eine Agentur die Ihren Ansprüchen entspricht und lassen Sie Ihres Handbuch übersetzen.

Grundsätzlich sollte die Technische Dokumentation in einem Format vorliegen, das es den Benutzern leicht zugänglich macht. Das kann in Papierform oder online oder auf einem Gerät sein.

Da Benutzer die Informationen in dem Moment haben möchten, in dem Sie sie brauchen und sie über viele Wege konsumieren, wäre es die beste Idee, das Handbuch auf mehreren Plattformen anzubieten.

In der EU müssen bei einigen Produktgruppen immer noch Gebrauchsanleitungen oder Gebrauchsanweisungen in Papierform beigefügt werden.

Philip hat sich für Folgendes entschieden:

• Er stellt eine vollständige, gedruckte Technische Dokumentation inklusive Sicherheitshinweisen mit dem Produkt zur Verfügung.
• Zusätzlich hat er eine separate Kurzanleitung für das Produkt entworfen.
• Er hat eine PDF-Version des gesamten Handbuchs online gestellt.
• Er wird auf seiner Website eine Online-Hilfe sowie die HTML-Version seines Benutzerhandbuchs bereitstellen. Dort kann er auch Videos einbetten. Und indem er die HTML-Version für Suchmaschinen optimiert, macht er es seinen Benutzern einfacher, Informationen zu finden.

Fazit

Das ist der ganze Trick! So konnte Philip mithilfe der Word Vorlage für Technische Dokumentationen und den Tools, die ich ihm zur Verfügung gestellt habe, eine rechtskonforme Technische Dokumentation schreiben.

Das Beste daran ist, dass Sie die gleichen Ergebnisse wie Philip erzielen können, indem Sie dieser Schritt-für-Schritt-Anleitung zur Erstellung Technischer Dokumentationen, Gebrauchsanleitungen, Gebrauchsanweisungen und Handbüchern folgen.

Wenn Sie dieses Fallbeispiel interessant fanden, würde ich mich freuen, wenn Sie Philips Geschichte auf Facebook oder Twitter teilen, oder unten einen Kommentar hinterlassen.

Ferry Vermeulen ist Experte für technische Kommunikation und Geschäftsführer von INSTRKTIV GmbH. Ferry hat es sich zur Aufgabe gemacht, digitale Benutzeranleitungen für alle Produkte der Welt zu erstellen. Hören Sie sich den INSTRKTIV-Podcast auf Spotify an oder lesen Sie einen seiner letzten Blogartikel.  Xing I Spotify I YouTube I Facebook I Twitter