Grundlagen der Technischen Dokumentation

Technik verständlich kommunizieren und verantworten. Zielpublikum:

Personen, die in der Technischen Dokumentation oder angrenzenden Bereichen tätig sind.

Ziele:

Sie können nach dem Kurs:

– Zielgruppenorientierte Informationsentwicklung anwenden: die Bedeutung und die Aufgaben der Technischen Dokumentation im Produktentwicklungsprozess einordnen, eine Zielgruppenanalyse durchführen und ein Dokumentationskonzept am Beispiel der Bedienungsanleitung erstellen.

– Texte für die Technische Dokumentation verfassen: Dokumentationsarten und ihre Nutzungsbereiche unterscheiden, die grundlegenden Schreibtechniken anwenden und Hilfsmittel wie den Redaktionsleitfaden für eine konsistente Textgestaltung einsetzen.

– Rechtliche und normative Anforderungen berücksichtigen: den Zusammenhang von Gesetzen, Verordnungen, Vorschriften, Normen und Richtlinien erläutern, Normen für die Schweiz und die EU nachprüfbar recherchieren, die Verhältnisse in den USA einordnen und Methoden der Risikobeurteilung anwenden.

– Lokalisierung und Mehrsprachigkeit planen: Methoden und Nutzen der Lokalisierung erläutern sowie Lokalisierungsprozesse gezielt planen und begleiten.

– Entwürfe beurteilen, redigieren und verantworten: bestehende Dokumentationen analysieren, KI-Werkzeuge gezielt einsetzen, die Entwürfe an den Kriterien des Fachs beurteilen, sie überarbeiten und das freigegebene Ergebnis verantworten.

Inhalt:

Technische Dokumentation ist Teil des Produktentwicklungsprozesses: Wer sie entwicklungsbegleitend schreibt, kann sie zielgruppenorientiert erstellen. Technische Redakteurinnen und Redakteure übersetzen dabei die Sprache der Fachleute aus der Entwicklung in die Sprache der Kundinnen und Kunden. Der Hersteller ist verpflichtet, dem Produkt eine verständliche Anleitung in den erforderlichen Sprachen beizulegen; zusätzlichen Nutzen bringt Dokumentation, die über mehrere Kanäle abrufbar ist.

Der Kurs vermittelt die Kenntnisse und Fertigkeiten, die dafür nötig sind, und zeigt, worauf bei der Erstellung zu achten ist. Er behandelt die Grundlagen des Fachs, die Informationsentwicklung von der Zielgruppenanalyse bis zum überarbeiteten Entwurf sowie die rechtlichen und normativen Aspekte.

Grundlagen:

– Bedeutung und Aufgaben der Technischen Dokumentation
– Dokumentationsarten und ihre Nutzungsbereiche
– Anforderungen an die Technische Dokumentation
– Methoden und Zweck einer Zielgruppenanalyse
– Methoden und Nutzen von Lokalisierung

Informationsentwicklung:

– Dokumentationskonzept am Beispiel der Bedienungsanleitung: Aufbau, Inhalte, Zugriff
– Schreiben für die Technische Dokumentation; Hilfsmittel wie der Redaktionsleitfaden
– Analyse bestehender Dokumentationen; Beurteilen und Überarbeiten von Entwürfen, auch selbst KI-gestützt erstellten

Rechtliche und normative Aspekte:

– Zusammenhang von Gesetzen, Verordnungen, Vorschriften, Normen und Richtlinien
– Schwerpunkt Schweiz und EU, Ausblick auf die USA; nachprüfbare Normenrecherche
– Methoden der Risikobeurteilung

KI-Werkzeuge liefern rasch Entwürfe, Formulierungsvarianten und Prüffragen zu einem Text; massgebend bleiben aber Norm, Recht, Risikobeurteilung und Produktkenntnis, und verantwortlich ist, wer den Text freigibt. Dazu gehören die betrieblichen Regeln: welche Systeme freigegeben sind, welche Daten hinein dürfen, wer freigibt und wie der Einsatz dokumentiert wird.

Der Kurs kann an den CAS Technische Dokumentation angerechnet werden oder einzeln als Microcredential zu anderen CAS, DAS oder MAS gestapelt werden.

Kompetenzen

Zielgruppenorientierte Informationsentwicklung anwenden
Sie erstellen ein Dokumentationskonzept und bereiten Inhalte strukturiert, verständlich und nutzerzentriert auf.

Texte für die Technische Dokumentation verfassen
Sie beherrschen die grundlegenden Schreibtechniken und nutzen Hilfsmittel wie den Redaktionsleitfaden für eine konsistente Textgestaltung.

Rechtliche und normative Anforderungen berücksichtigen
Sie kennen die relevanten Regelwerke (Schweiz, EU, USA), recherchieren Normen nachprüfbar und setzen die Anforderungen in der Dokumentation um.

Lokalisierung und Mehrsprachigkeit planen
Sie verstehen die Bedeutung sprachlicher Anpassung und können Lokalisierungsprozesse gezielt planen und begleiten.

Entwürfe beurteilen, redigieren und verantworten
Sie setzen KI-Werkzeuge gezielt ein, beurteilen die Entwürfe an den Kriterien des Fachs, überarbeiten sie und verantworten das freigegebene Ergebnis.