Crashkurs in Technischer Dokumentation

Grundlagen der Technischen Dokumentation

• Anforderungen an Anleitungen: Spezifikation und Definitionen aus Rechtsrahmen, Kundenanforderungen, Corporate Documentation
• EU-Richtlinien, Gesetze, Normen: Die einschlägigen Vorschriften für Technik-Redakteure
• Überblick über die Mutter der Dokumentationsnormen:
  Die DIN EN 82079-1 und die Richtlinie VDI 4500
• Restrisiken abfangen: Lesen und Umsetzen der Risikobeurteilung
• Warn- und Sicherheitshinweise formulieren und gestalten: Abfangen von Restrisiken für den Nutzer und sein Umfeld
• Inhalte zusammenstellen: Auswählen und
  Strukturieren notwendiger Informationen, Modularisieren in Bausteinen, Standardisieren von Inhalten
• Professionelles Deutsch für Techniker: Grundregeln des
  Formulierens, typische Fehler in Texten vermeiden, zielgruppenbezogen texten

Mit System planen und organisieren

• Ressourcen bereitstellen: Qualifizierte Redakteurinnen und Redakteure, angemessene Hard- und Software-Ausstattung, ausreichende Arbeitszeiten von der Recherche bis zum Lektorat
• Zuständigkeiten und Verantwortlichkeiten festlegen
• Software gezielt auswählen: DTP, Schreibprogramm oder
  Redaktionssystem?
• Dokumentationsprozesse festlegen: Die Phasen der Dokumen-
  tationserstellung, vom Lastenheft bis zur Publikation
• Publikation mediengerecht vorbereiten: Für den Druck vorbe-
  reiten, für Mobile Technische Dokumentation optimieren, für das Verteilen über globale Netze anpassen
• Redaktionsleitfaden nutzen: Standardisieren – von den
  eingesetzten Tools über die Dokumentation der Recherche bis hin zu Style-Guides und Formulierungsfragen

Anleitungen optimieren

• Gemeinsame Besprechung von mitgebrachten Teilnehmer-
  Anleitungen und Ausloten von Verbesserungspotential
• Baustellen identifizieren und Gegenmaßnahmen in den
  heimischen Prozessen und der eigenen Arbeit diskutieren
• Sicherheitsrelevante Kapitel und Absätze analysieren, mit den einschlägigen gesetzlichen und normativen Vorgaben abgleichen
• Rechtskonformität beurteilen, Angriffspunkte minimieren↓

Workshop: Um den Weg zu einer normgerechten und
zielgruppenorientierten Anleitung besser einschätzen zu können, werden Sie in Gruppenarbeit eine neue Anleitung erstellen

• Wir wählen ein typisches Produkt aus, das einfach genug ist, damit wir den Zeitrahmen bestmöglich nutzen.
• Wir analysieren die vom Hersteller beigefügte Anleitung und bewerten sie in einer Schwachstellen-Analyse.
• Ganz systematisch werden Sie ein Lastenheft für die neue
  Anleitung erstellen, sich dabei an der DIN EN 82079 orientieren.
• In kleinen Gruppen werden Sie die einzelnen Anforderungs-
  kriterien umsetzen, von der Recherche über die Zielgruppen-
  Analyse bis hin zu Inhaltsstruktur, Texten und ggf. Bildern.

Das wesentliche Ergebnis des Workshops wird nicht primär diese Anleitung sein, sondern dass Sie nun aus Erfahrung
wissen, wie Sie bei Ihren eigenen Anleitungen vorgehen müssen.