Software-Dokumentation
Beschreibung
Software-Dokumentation umfasst Software-Hilfen, Release Notes, Erste Schritte, Tipps+Tricks, Systemvoraussetzungen und Installations- bzw. Deinstallationsanleitungen aber auch die Oberflächentexte unter dem Schlagwort User Assistance (UA) und die zugehörigen UX-Texte.
Die Software-Dokumentation informiert den Benutzer über den Gebrauch der Software, über Software-Befehle, Fehlermeldungen und vieles mehr.
Software tritt in verschiedenen Ausprägungen auf, z. B. Anwendungssoftware, Software für die Maschinensteuerung und System-Software.
In diesem Seminar lernen Sie, wie Sie Software-Dokumentation planen, erstellen und publizieren. Schwerpunkte sind dabei die Vorüberlegungen und was Sie bei der Konzeption beachten müssen, um bei Ihren Nutzern zu punkten.
Zielgruppe
Personen, die mit der Erstellung, Überarbeitung und Prüfung von Software-Dokumentation befasst sind: Technische Redakteure, Neu- und Quereinsteiger, Software-Entwickler, Studierende mit Fachrichtung Technische Redaktion und Technische Kommunikation
Voraussetzungen
Keine
Methodik
Präsentation, Übung, Diskussion
Seminarthemen
Grundlagen
-
Begriffe und Definitionen rund um die Software-Dokumentation
-
Arten und Ausprägungen von Software-Hilfe, z. B. Embedded Help, kontextfreie- und kontextsensitive Hilfe
-
Grundlagen der Terminologie
Gesetzliche Anforderungen und normative Empfehlungen
-
Software als Produkt nach dem Produktsicherheitsgesetz (ProdSG) bzw. Produkthaftungsgesetz (ProdHaftG)?
-
Höchstrichterliche Rechtsprechung
-
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
Dokumentationskonzept:
-
Inhalte und Tabu-Inhalte der Software-Hilfe
-
Grundlagen Layout und Gestaltung: Der erste Eindruck zählt, der letzte bleibt!
-
Besonderheiten der Bildschirmausgabe
-
Verständliche Texte – Zufriedene Leser oder: Einer muss sich plagen, entweder der Schreiber oder der Leser.
-
Darstellung von Bildern und Tabellen
-
Inhaltliche Erschließung: Inhaltsverzeichnis, Index, Suche, Verlinkungen, Abbildungs- und Tabellenverzeichnis
-
Barrierefreie Dokumentation – Was heißt das?
-
Standardisierungsmethoden in der Technischen Dokumentation
-
Software-Hilfe kürzen unter Beachtung der Prinzipien des Minimalismus
-
Herzstück der Technischen Redaktion: der Redaktionsleitfaden
Sicherheits- und Warnhinweise
-
Sicherheits- und Warnhinweise in der Software-Dokumentation?
-
Darstellung nach DIN EN IEC/IEEE 82079-1 Erstellung von Nutzungsinformationen (Gebrauchsanleitungen) für Produkte - Teil 1: Grundsätze und allgemeine Anforderungen und ANSI Z535.6-2011 (R2017) Product Safety Information
-
Formulierung nach der SAFE-Methode
Übersetzung und Publikation
-
Single Source Publishing bzw. Cross Media Publishing bzw. Multi Channel Publishing
-
Ausgabemedien: Bildschirm, Papier, Video und mobile Endgeräte
-
Ausgabeformate, z. B. HTML5, Microsoft HTML Help (CHM), App und PDF
-
Content Delivery Portal, die richtige Information zu richtigen Zeit an die richtige Person
-
Übersetzung mit dem Übersetzungsdienstleister bzw. Translation Memory Systemen (Darstellung Übersetzungsprozess)
-
Maschinelle Übersetzung
-
Übersetzungsgerechtes Schreiben
Trends und Entwicklungen
-
Spezialisierung des Berufsbildes im Bereich Software-Dokumentation
-
UX Writing – Was die Oberfläche zeigt
-
Standards für die Technische Dokumentation: Intelligent information Request and Delivery Standard (iiRDS)
-
Künstliche Intelligenz in der Technischen Redaktion – Freund oder Feind?
Seminarunterlagen
Jeder Teilnehmer erhält gedruckte, hochwertige, deutschsprachige Seminarunterlagen.
Inhaltsverzeichnis und Leseprobe
Seminarbescheinigung
Jeder Teilnehmer erhält eine personalisierte Teilnahmebescheinigung.
Seminardaten
Offenes Online-Seminar
-
Ort:
-
Dauer: 2 Tage mit 8 Blocks á 90 Minuten
-
Beginn / Ende:
-
Leistungen:
-
€ 945,00 zzgl. ges. MwSt.
: -
Seminarleitung:
oder
Offenes Präsenzseminar
-
Ort: 73240 Wendlingen am Neckar
-
Dauer: 2 Tage
-
Beginn / Ende:
, -
Leistungen:
-
€ 945,00 zzgl. ges. MwSt.
: -
Seminarleitung:
oder -
Übernachtung: Hotelauswahl
tekom-Rezertifizierung
Dieses Seminar dient als Nachweis für die tekom-Rezertifizierung.
VDSI-Punkte
Dieses Seminar ist eine anerkannte Fortbildungsveranstaltung vom Verband für Sicherheit, Gesundheit und Umweltschutz bei der Arbeit e.V.
Sie erhalten für Ihren VDSI-Weiterbildungsnachweis: