Checkliste zur Erstellung von Anleitungen

Teile diesen Beitrag

Checkliste zur Erstellung von Anleitungen – Anforderungen an die Gestaltung von Bedienungs- und anderen Anleitungen sind in Normen festgelegt. Der neue Stand der Technik –  EC/IEE 82079-1 Edition 2. Im Mai ist die Norm EC/IEE 82079-1 erschienen. Die Norm besteht aus 56 Seiten verteilt auf zehn Kapiteln mit Vorgaben für den Inhalt von Anleitungen. Außerdem stellt die neue Norm Anforderungen an den Erstellungsprozess von Technischer Dokumentation und definiert die Kompetenzen, die ein/e Technische/r Redakteur/in haben muss.

Sie finden hier eine Checkliste zur Erstellung von Anleitungen in der Technischen Dokumentation.

Checkliste zur Erstellung von Anleitungen

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.