FAQ Category: Betriebsanleitung erstellen

Nein, viele wichtige und sicherheitsrelevante Informationen finden sich in Anleitungen oder auch Erklärungen. In Wikipedia ist z. B. eine genaue Beschreibung der Absturzursachen der Boing 737 Max zu finden. Hier gibt es drei Stellen, die die Bedeutung von Dokumentation und Schulung verdeutlichen: MCAS (ein automatisches Fluglageregelsystem) und seine möglichen Fehlfunktionen wurden den Piloten jedoch nie … Weiterlesen

Können Gefahren bei einer bestimmten Handlung auftreten, ist es wichtig vor diesen Gefahren zu warnen. Beispielsweise bei einer Wartungsarbeit. Es reicht nämlich nicht nur die Warnhinweise im Sicherheitskapitel aufzuführen. Der Ersteller der Betriebsanleitung darf nämlich nicht annehmen, dass der Leser jedes Mal das Sicherheitskapitel vorher aufschlägt.

Eine gute Textverständlichkeit in einer Betriebsanleitung ist eine der wichtigsten Aspekte für uns Technische Redakteure. Aber wie erreiche ich das? Hier ein paar Tipps: Haben Sie Ihre Zielgruppe im Blick! Passen Sie Ihre Texte Ihrer Zielgruppe an. Schreiben Sie für einen unerfahrenen Nutzer oder für eine gelernte Fachkraft? Müssen Fachwörter erklärt werden oder nicht? Schreiben Sie möglichst … Weiterlesen

Das ist kurz und knapp zu beantworten. Ja, Ihre Betriebsanleitung braucht eine Beschreibung des Produktes. Auch die bestimmungsgemäße Verwendung des Produktes muss beschrieben werden.

Die Betriebsanleitung muss alle Phasen des Produktlebenszyklus abbilden. Von der Beschreibung des Produktes über den Transport, Montage, Inbetriebnahme, Bedienung, Wartung, Reparaturarbeiten bis hin zur Entsorgung. Dies muss allerdings nicht alles einer einzigen Betriebsanleitung stehen. Sie können die Betriebsanleitung auch in mehrere Dokumente aufteilen.

Es müssen zuerst einige Dinge geklärt werden, bevor Sie eine Bedienungsanleitung erstellen: Definition des Produktes Bestimmungsgemäßer Gebrauch Unsachgemäßer Gebrauch Risikobeurteilung Welche Richtlinien und Normen gelten für mein Produkt? Alle Technischen Daten, Messprotokolle, Spezifikationen, Zuliefererkomponenten, Zertifikate usw. müssen gesammelt und in einem Technischen Ordner verwahrt werden

Die interne Dokumentation eines Herstellers ist ursprünglich nicht die Aufgabe der Technischen Redaktion. Sie ist grundsätzlich von anderen Fachabteilungen des Herstellers zu erledigen. Die Technische Redaktion kann jedoch wertvolle Unterstützungsarbeit leisten.

Achten Sie darauf, dass die Inhalte Ihrer Betriebsanleitung leicht lesbar und auf Ihre Zielgruppe angepasst sind. Nur welche Zielgruppen werden in der Technischen Dokumentation angesprochen? Eins ist klar. Die Zielgruppe Ihres Produktes ist vorwiegend der Endnutzer bzw. Anwender. Aber auch andere Zielgruppen werden in Ihrer Betriebsanleitung angesprochen. Beispielsweise das Montagepersonal, Wartungspersonal oder der Inbetriebnehmer.

Eine gute Betriebsanleitung für Software hilft dem Endbenutzer, der mit der Software arbeitet, die Funktionen und Eigenschaften zu verstehen und bietet dem Endbenutzer alle wichtigen Informationen an, um die Software zu benutzen. Ihre Betriebsanleitung erklärt, wie Ihre Software funktioniert, wie der Endbenutzer die Software bedient und wie sie entwickelt wurde.

Screenshots sind besonders sinnvoll bei Betriebsanleitungen von Software-Produkten, da Sie die Benutzeroberfläche abbilden. Der Nutzer kann sich somit hervorragend orientieren und jeden Schritt besser nachvollziehen als mit reinem Text.