Software-Dokumentation

Beschreibung

In diesem Seminar betrachten wir die Grundlagen der effektiven Software-Dokumentation und Best Practices zur Erstellung von Software-Dokumentation. Eine gute Software-Hilfe kann entscheidend für den Umgang mit der Software und für die User Experience sein.

Sie erfahren, wie Sie Informationen strukturiert aufbereiten, komplexe Inhalte leicht verständlich vermitteln und dokumentierte Prozesse aktuell halten.

Das Seminar richtet sich an Entwickler, Technische Redakteure und Projektmanager, die ihre Dokumentationsfähigkeiten verbessern und eine reibungslose Kommunikation im Softwareentwicklungsprozess sicherstellen möchten.

Voraussetzungen

Keine

Ziele

• Grundwissen für fachgerechte Software-Dokumentation

• Überblick über die Kernkompetenzen Technischer Redakteure

• Zielgruppengerechte und benutzerfreundliche Informationen erstellen

• Kürzungspotential und relevante Ergänzungen erkennen

• Einblick in aktuelle Entwicklungen, z. B. UX-Writing

Themen

Grundlagen

• Begriffe und Definitionen rund um die Software-Dokumentation

• Arten von Software-Hilfen

• Grundlagen Terminologie-Management

Gesetzliche Anforderungen und normative Empfehlungen

• Software als Produkt nach der neuen Produkthaftungsrichtlinie

• Normen für die Erstellung von Software-Dokumentation, z. B. DIN EN IEC/IEEE 82079-1 Erstellung von Nutzungsinformationen für Produkte und ISO/IEC/IEEE 26514 (2022) Design and development of information for users

Planung und Organisation

• Organisationsverantwortung, Kostentreiber und Qualitätskiller erkennen

• Wer? Wie? Was? – Software-Analyse, Tätigkeitsanalyse und Zielgruppenanalyse

• Professionelle Software zum Erstellen von Technischer Dokumentation: Help Authoring Tool vs. Content Management-System (CCMS)

Kernkompetenzen Technischer Redakteure

• Inhalte und Tabu-Inhalte der Software-Hilfe

• Layout und Gestaltung: Der erste Eindruck zählt, der letzte bleibt

• Besonderheiten der Bildschirmausgabe, z. B. HTML5 bzw. WebHelp

• Verständliche Texte – Einer muss sich plagen, entweder der Schreiber oder der Leser.

• Darstellung von Bildern und Tabellen

• Inhaltliche Erschließung und Auffindbarkeit von Informationen

• Barrierefreie Dokumentation – Was heißt das?

• Standardisierungsmethoden in der Technischen Redaktion

• Software-Hilfe kürzen unter Beachtung der Prinzipien des Minimalismus

• Herzstück der Technischen Redaktion: der Redaktionsleitfaden

Übersetzung und Publikation

• Single Source Publishing bzw. Cross Media Publishing bzw. Multi Channel Publishing

• Ausgabemedien: Bildschirm, Papier, Video, mobile Endgeräte

• Content Delivery Portal, die richtige Information zur richtigen Zeit an die richtige Person

• Übersetzung mit dem Übersetzungsdienstleister – Darstellung Übersetzungsprozess mit Translation Memory Systemen bzw. CAT-Tool

• Maschinelle Übersetzung

• Übersetzungsgerechtes Schreiben

Trends und Entwicklungen

• UX-Writing – Was die Oberfläche zeigt

• Künstliche Intelligenz in der Technischen Redaktion – Freund oder Feind?

• Was ist der Intelligent information Request and Delivery Standard (iiRDS)?

• Chatbot als Medium für die Software-Hilfe?

Auf einen Blick

Dauer: 2 Tage

Ort: Online (MS Teams oder Zoom)

Trainingsmaterial: Seminarunterlagen (Deutsch)

Anzahl Teilnehmer: Max. 6 Personen

Kosten pro Person: € 945,00 zzgl. ges. MwSt.

Referentin: Birgit Becker

Termine

04.-05.06.2025

17.-18.09.2025

01.-02.12.2025

Zum Seminar anmelden

Individuelles Firmenseminar anfragen