Zurück zur Übersicht

Seminar
Technische Dokumentation kompakt

Schnelle Orientierung für Quer- und Neueinsteiger - Was ist heute Stand der Technik? - Hinweise zu Methoden und Software - Ein „Hilfe zur Selbsthilfe“-Paket

Angestellte in der Technischen Dokumentation kommen aus den unterschiedlichsten Berufen. Sie können aus der Verwaltung kommen, aus der Konstruktion, dem Grafikdesign oder dem Service. Sie können Techniker, Meister oder promovierter Chemiker sein, und anderes mehr. Und nicht alle haben eine Aus- oder Fortbildung an einer Hochschule oder einer Fortbildungseinrichtung durchlaufen und sind systematisch auf die Arbeit in der Technischen Redaktion vorbereitet.

Heute treffen die Mitarbeitenden in den Technikredaktionen auf eine Realität, die durch Gesetze und Normen sehr hohe Anforderungen an die Qualität in der Technischen Dokumentation stellt und sich mit der digitalen Transformation zudem rasch wandelt. Das betrifft vor allem Betriebsanleitungen und Gebrauchsanweisungen von technischen oder medizinischen Geräten, Maschinen, Anlagen, Komponenten oder Software.

Anhand ganz konkreter Beispiele erhalten Sie einen Überblick über die wichtigen Themen der Technischen Kommunikation, sodass Sie über weitere konkrete Schritte entscheiden können. Und Sie bekommen ein Feedback zu Ihrer Dokumentation und klare Antworten auf Ihre Fragen.

Hinweise und detaillierte Informationen zum Veranstaltungsformat finden Sie nachfolgend im Text.

Seminarinhalt auf einen Blick

  • Was ist heute Stand der Technik?
  • Hinweise zu Methoden und Software
  • Anforderungen aus Gesetzen und Normen
  • Adressatengerecht recherchieren und texten
  • Standardisierungs-Techniken
  • Ein „Hilfe zur Selbsthilfe“-Paket
  • Basis-Know-how zur schnellen Orientierung

Ihr Nutzen

Das Seminar soll denjenigen, die Aufgaben in der Technischen Dokumentation erfüllen und nicht unbedingt dafür ausgebildet sind, Orientierung geben, welche Standards in der Dokumentation heute bestimmend sind und mit welchen Methoden und Hilfsmitteln in den Technischen Redaktionen gearbeitet wird – oder werden müsste. Den Teilnehmenden am Seminar wird eine umfangreiche Dokumentation mitgegeben, sozusagen ein „Erste-Hilfe-Paket“, mit dem eine gute Basis für die eigene Arbeit geschaffen wird. Vor allem gibt es Orientierung, wie die Prioritäten zu setzen sind. Eines muss betont werden: Dieses Seminar ersetzt keine grundlegende Aus- oder Fortbildung im Themenfeld „Technische Dokumentation“. HINWEIS: Es können eigene Anleitungsbeispiele mitgebracht werden, die, soweit es der Zeitplan zulässt, im Rahmen des Seminars besprochen werden können.

Seminarprogramm

  • Themen und Zusammenhänge im Überblick
  • Stärken und Schwächen in der Dokumentation identifizieren
  • Anforderungen durch Gesetze und Normen
  • IEC/IEEE 82079-1 und ANSI Z535
  • Risikobeurteilung und Sicherheits- und Warnhinweise
  • Informationen zielgruppengerecht recherchieren
  • Redaktionelles Basis-Know-how
  • Anwendungsbeispiele
  • Bilder und Grafiken funktionsgerecht einsetzen
  • Methodisch strukturieren und standardisieren
  • Wozu dienen Redaktionssysteme?
  • Übung: Analysieren, Optimieren, Standardisieren
  • Redaktionsleitfaden: Dokumentieren und festigen der „Spielregeln“ in der Technischen Redaktion
  • Software-Tools und Trends, die man kennen sollte
  • Qualitätsstandards in der Dokumentation konsequent durchziehen
  • Hinweise für die Umsetzung in die Praxis

Das Seminarprogramm im Detail




Themen und Zusammenhänge im Überblick

  • „Interne“ und „externe“ Technische Dokumentation (VDI 4500)
  • Wesentliche Know-how-Bausteine für die Technische Redaktion
  • Kommentierte praxisorientierte Literatur und Institutionen

Stärken und Schwächen in der Dokumentation identifizieren

  • Stärken und Schwächen erkennen mit der Analyse-Methode „Problemtypologie“
  • Problembereiche und Lösungsstrategien für die Dokumentationsabteilung

Anforderungen durch Gesetze und Normen

  • Nationale und internationale Gesetze, Normen, Richtlinien
  • Zentrale und heikle Punkte für die Technische Dokumentation
  • Qualitäts-Messlatte IEC/IEEE 82079-1
  • US-Produkthaftung: Mythos und Wahrheit

Risikobeurteilung sowie Sicherheits- und Warnhinweise

  • Risikoanalyse (nach DIN EN ISO 14121)
  • Grundlegende Sicherheitshinweise
  • Warnhinweise nach ANSI Z 535 und ISO 3864

Informationen zielgruppengerecht recherchieren

  • Methoden der Produkt- und Zielgruppenanalyse
  • Abstrakte Zielgruppen lebendig und greifbar machen
  • Recherche im Redaktionsprozess

Redaktionelles Basis-Know-how Teil 1

  • Die wichtigsten Begriffe zur Terminologie-Normung
  • Typische Fallen bei Wortschatz und Satzbau

Redaktionelles Basis-Know-how Teil 2

  • Textfunktionen eindeutig bestimmen und klar kommunizieren
  • Sequenzierung: Alles in die richtige Reihenfolge bringen
  • Typografie und Layout funktionsgerecht einsetzen

Anwendungsbeispiele

  • Exemplarische problemtypologische Analyse

Ende des 1. Seminartags gegen 17.00 Uhr

Bilder und Grafik funktionsgerecht einsetzen

  • Grundlagen der Verarbeitung von Bildern
  • Bilder funktional und konsistent einsetzen
  • Festlegungen für den Einsatz von Bildern und Grafiken

Methodisch Strukturieren und Standardisieren

  • Standardisierung: Qualität sichern, Übersetzungskosten einsparen
  • Kurze Übersicht: Was sind Standardisierungsmethoden?
  • Einführung in die Standardisierungsmethode „Funktionsdesign“

Wozu dienen Redaktionssysteme?

  • Strukturierung und Standardisierung als Voraussetzung
  • Kriterien für oder gegen den Einsatz von XML
  • Was leisten Redaktionssysteme, wann braucht man sie?

Übung: Analysieren, Optimieren, Standardisieren

  • Zusammenführung wesentlicher Bausteine in Praxisbeispielen
  • Analyseergebnisse in Regelwissen überführen

Redaktionsleitfaden: Dokumentieren und festigen der „Spielregeln“ in der Technischen Redaktion

  • 10 gute Gründe für dokumentierte Standards
  • Redaktionsleitfäden für unterschiedliche Bedürfnisse

Software-Tools und Trends, die man kennen sollte

  • Wirtschaftlich übersetzen (lassen) mit Translation Memory-Systemen (TMS)
  • Kriterien für den Einsatz von Content Management-Systemen (CMS)

Qualitätsstandards in der Dokumentation konsequent durchsetzen

  • Kennzahlen: Wo steht das Unternehmen in Sachen Dokumentation?
  • Methodisch arbeiten, das „Standing“ der Technischen Redaktion
  • Realistische Strategien auf dem Weg zu mehr Qualität

Schlussdiskussionen und Hinweise für die Umsetzung in die Praxis

Ende des 2. Seminartags gegen 17.00 Uhr

Zielgruppen

Alle Personen aus Entwicklung, Konstruktion, Produktmanagement oder Marketing als auch Leiter und Leiterinnen von Technikredaktionen, die sich schnell über den aktuellen Stand der Technischen Dokumentation informieren wollen, Ein- und Quereinsteiger, die schnell ein Grundverständnis dafür bekommen sollen, worauf es heute in der Technischen Dokumentation ankommt.

Allgemeine Hinweise zur Seminarteilnahme je nach Veranstaltungsformat

Hinweise bei Teilnahme an Präsenz-Seminaren
(bei Teilnahme an Live-Online-Seminaren siehe Information nachfolgend):

Im Seminarpreis enthalten:
- Seminarunterlagen
- Teilnahmezertifikat
- inkl.Vollverpflegung vor Ort

Unsere Veranstaltungen werden in der Regel im Format Online und Präsenz angeboten. Abhängig vom Buchungsverhalten und den Rahmenbedingungen behalten wir uns das Recht vor, das Veranstaltungsformat zu wechseln, bzw. einzuschränken.

Hinweise bei Teilnahme an Live-Online-Seminaren:
Im Seminarpreis enthalten:
- Seminarunterlagen als PDF
- Teilnahmezertifikat
- Zugang zur Plattform

Wir planen unsere Live-Online-Seminare generell so, dass die Wissensvermittlung und die Übungseffekte unseren Präsenzseminaren entsprechen (inklusive fallweise Gruppenarbeiten und Übungsaufgaben; Fragen können jederzeit gestellt werden). Die bisherigen positiven Teilnehmerfeedbacks zeigen uns, dass dieses Seminarformat funktioniert.

- Sie erhalten die Einwahldaten zum Live-Online-Seminar einige Tage vor der Veranstaltung.
- Grundvoraussetzungen zur Teilnahme sind ein Internetanschluss, ein Computer/Tablet und ein Headset bzw. Mikrofon & Lautsprecher. Eine Webcam für den persönlicheren Austausch wäre sehr wünschenswert.
- Für unsere Online-Seminare kommt hauptsächlich die Software Zoom (Link zur Prüfung Ihrer Technik) zum Einsatz. Vereinzelt auch GoToMeeting (Link zur Prüfung Ihrer Technik) oder MS Teams.
- Es werden in Abstimmung mit den Teilnehmern ausreichend Pausen eingeplant.
- Die Teilnehmerunterlagen erhalten Sie vor, während oder im Nachgang des Seminars als Download oder per Mail.

DARSTELLUNGSPROBLEME / HINWEIS ZU IHREM BROWSER
Sehr geehrte Besucher*innen,

Sie verwenden zur Darstellung unserer Internetseite den Browser „Microsoft Internet Explorer“, was in den meisten Fällen zu fehlerhaften Darstellungen der Inhalte und zu starken Funktionseinschränkungen führt.

Um unsere Website optimal nutzen zu können, verwenden Sie bitte einen alternativen Browser, wie zum Beispiel Microsoft Edge, Google Chrome, Mozilla Firefox oder Apple Safari.

Entschuldigen Sie bitte die Umstände und vielen Dank für Ihr Verständnis!

Ihr VDI-Team