Checkliste zur Erstellung von Anleitungen

Teile diesen Beitrag

– unter Berücksichtigung der Maschinenrichtlinie 2006/42/EG, EN ISO 12100:2010 und EN 82079-1:2012

Checkliste zur Erstellung von Anleitungen – Häufig fehlen Unternehmen im stressigen Alltag die Zeit und/oder das Wissen für eine gründliche Recherche der relevanten Gesetze, Verordnungen, Richtlinien und Normen für die Erstellung von technischer Dokumentation.

Denn die technische Dokumentation wird als Produktbestandteil betrachtet und muss daher wie das Produkt selbst ”dem aktuellen Stand der Technik” entsprechen. Dem aktuellen Stand der Technik entspricht Ihre Dokumentation, wenn Sie die Vorgaben erfüllt.

Die Checkliste zur Erstellung von Anleitungen habe ich einem eBook zusammengefasst.

Die Checkliste enthält eine ausführlichen Tabelle mit über 100 Checkpunkten, welche Bestandteile eine technische Dokumentation erfüllen muss, unter Berücksichtigung der Maschinenrichtlinie  2006/42/EG,  EN ISO 12100:2010, EN 82079-1:2019.

Checkliste zur Erstellung von Anleitungen

Dies ist ein Auszug aus der Checkliste:

Titelblatt/Titelei

  • Genauer Produktname (ggf. Typ/Versionsnummer) angegeben?
  • Art der Anleitung benannt (mit Ausgabe/Versions-/Revisionsnummer, ggf. Bestellnummer)?
  • Name und Adresse des Herstellers angegeben?
  • Impressum mit Copyright-Vermerk vorhanden?
  • Ggf. eingetragene Warenzeichen berücksichtigt?
  • Ggf. CE-Zeichen angebracht?
  • Ggf. Hinweis zur Bedeutung der Anleitung gegeben?

Inhaltsverzeichnis

  • Inhaltsverzeichnis erforderlich?
  • Inhaltsverzeichnis übersichtlich gestaltet?

Abkürzungsverzeichnis

  • Abkürzungsverzeichnis erforderlich?
  • Abkürzungsverzeichnis vollständig?

Sicherheitshinweise

  • Sicherheitshinweise erforderlich?
  • Sicherheitshinweise sinnvoll platziert?
  • ggf. Verwendungszweck spezifiziert?
  • Ggf. Adressatengruppe spezifizier?

Textteil

  • Struktur tätigkeitsorientiert?
  • Parallele Konstruktionen in den Überschriften?
  • Logische und sinvolle Gliederungshierarchie?
  • Instruktionen zu folgenden Punkten erforderlich/enthalten?
  • Transport/Handhabung/Lagerung
  • Installation/Inbetriebnahme
  • Benutzung/Bedienung/Betrieb
  • Wartung/Pflege/Instandhaltung
  • Störungsabhilfe/Fehlerbeseitigung
  • Außerbetriebnahme/Abbau/Entsorgung
  • Energiesparmöglichkeiten/umweltfreundliche Nutzung
  • Reparatur
  • Terminologie weckt keine falschen Assoziationen?
  • Zusicherungsfehler vermieden?
  • Bei Maschinen EG-Richtlinie Maschinen beachtet?
  • Sprachliche Darstellungshinweise wertet Produkt und Hersteller-Image auf?

Glossar

  • Glossar erforderlich?
  • Glossar vollständig?
  • Im Glossar erklärte Ausdrücke ggf. im Text hervorgehoben?

Stichwortverzeichnis

  • Stichwortverzeichnis erforderlich?
  • Stichwortverzeichnis vollständig?
  • Stichwortverzeichnis am Sprachgebrauch der Adressaten orientiert?
  • Synonyme berücksichtigt?
Teile diesen Beitrag

Mustafa Acar

Mustafa Acar ist Business Architect aus Stuttgart und befasst sich gerne mit Themen rund um Mixed Reality, Technische Dokumention, Content Development und der dazugehörigen technischen Umsetzung. Als studierter Kommunikation und Medienmanager hat er zudem eine große Sympathie für benutzerspezifische produktorientierte Informationsaufbereitung.