Der Kurs bietet eine Übersicht über die relevanten Grundlagen der Technischen Dokumentation. Ausgehend von der zentralen Frage "Was ist Technische Dokumentation?" wird das vielfältige Tätigkeitsspektrum des Technischen Redakteurs detailliert erörtert. Die Teilnehmer erhalten einen umfassenden Einblick in den aktuellen Stand der Technik. Die Vorstellung grundlegender Konzepte und zahlreicher Beispiele sorgen für eine optimale Kombination aus Theorie und Praxis, die den Teilnehmern die rasche Umsetzung ihrer erworbenen Kenntnisse in der täglichen Arbeit ermöglichen.

Zielgruppe / Voraussetzungen

Dieser Kurs richtet sich an

• Quereinsteiger in die Technische Dokumentation, die einen kompakten und praxisnahen Einstieg in die technische Dokumentation benötigen,
• an Redakteure, die ihr Fachwissen erweitern und auffrischen wollen sowie
• an Verantwortliche, die ein Redaktionsteam aufbauen bzw. die Zusammenarbeit mit externen Redakteuren und Dienstleistern organisieren möchten.

Kursinhalt

Was ist Technische Dokumentation?

• Begriffsdefinition und Abgrenzung
• Arten der Technischen Dokumentation
• Gesetze, Normen und Richtlinien

Texte verständlich gestalten

• Verständlichkeit, Verständlichkeitsmodelle
• Sprache und Grammatik
• Übersetzungsgerechtes Schreiben

Dokumentation benutzerfreundlich gestalten

• Grundstruktur einer Technischen Dokumentation
• Gestaltungselemente
• Wahl des Mediums (Print, Online, ...)
• Orientierungshilfen
• Einsatz von Bildern, Illustrationskonzept
• Layout-Regeln
• Typographie
• Dokumentvorlagen
• Tools

Strukturierungsmethoden

• Überblick über verschiedene Methoden
• Umsetzungen in Standards (DITA, DocBook, ...)
• Die 5W-Fragen
• Topic-orientiertes Schreiben
• Programme zur Dokumentationserstellung

Projektmanagement

• Schnittstellen und Prozesse
• Planung
• Ablauf typischer Dokumentationsprojekte
• Phasen der Dokumentationserstellung, Lebenszyklus
• Selbstmanagement

Qualitätsmanagement

• Zielsetzung
• Warn-/Sicherheitshinweise
• Redaktionsleitfaden
• Checklisten
• Terminologie
• Redaktionsprozess
• Test
• Umsetzung in der Praxis