Online-Seminar | Grundlagen der Softwaredokumentation

In diesem Seminar dreht sich alles um die Grundlagen der modernen Softwaredokumentation und die Technik, Anwender:innen durch die digitale Welt zu führen. Wir zeigen dir, wie du komplexe Software verständlich und nutzerfreundlich dokumentierst, damit deine User:innen nicht nur den Durchblick behalten, sondern auch effizient arbeiten können.

Du lernst, wie du Dokumentationen strukturiert, zielgerichtet und effektiv erstellst – von der ersten Idee bis zur Veröffentlichung. Dabei geht es nicht nur um das Schreiben selbst, sondern auch darum, wie du Informationen sinnvoll ordnest, verknüpfst und für verschiedene Medien aufbereitest. Ob du Anleitungen, Hilfetexte oder umfassende Dokumentationen erstellst, nach diesem Seminar weißt du, wie es richtig geht. Und das Beste: Es ist praxisnah, interaktiv und macht Spaß!

Kurz gesagt: Es geht darum, deine Softwaredokumentation auf das nächste Level zu bringen und deine Nutzer:innen glücklich zu machen.

• Dokumentation im Software-Lebenszyklus
  Lerne, welche Dokumente im Laufe eines Software-Lebens und in welcher Phase des Softwarelebenszyklus erstellt werden.
• Rechtliche und normative Anforderungen
  Was steht in den einschlägigen Normen wie der 82079-1 oder der Normreihe 26511-26515 zur Softwaredokumentation und was bedeutet das im Alltag?
• Technische Dokumentation im Web
  Wie wir heute suchen, finden und filtern. Warum wir alles googlen und was wir im Web erwarten.
• Vom Chaos zur Ordnung
  Gute Informationsarchitekturen verstehen, entwickeln und anwenden.
• Zerlegen, Ordnen und Würfeln
  Grundlagen modularer Technischer Dokumentation: Was sind Topics, Information-Mapping und DITA?
• Kleine Informationseinheiten, gut beschrieben.
  Minimalistisch, aufgabenorientiert und strukturiert Schreiben. Topics richtig erstellen, zusammenstellen und publizieren.
• Zwischen den Topics gelesen – Metadaten.
  Grundlagen und Vorteile von Metadaten. Wie Metadaten geplant werden können und wofür du diese brauchen und einsetzen wirst.
• Link ist nicht gleich Link – nicht jeder Link ist hilfreich
  Nutzer an die Hand nehmen. Informationen richtig linken und verknüpfen.
• Alles aus einer Hand – Inhalte medienunabhängig wiederverwenden.
  Welche Vorteile das Single-Source-Publishing hat und wie du deine Inhalte medienunabhängig nahezu überall wiederverwenden kannst.
• Dokumentation im agilen Projektumfeld
  Softwaredokumentation im schnelllebigen Umfeld planen, erstellen, ausliefern und vor allem aktuell halten – geht das?

Dieser Kurs ist ideal für alle, die mit Softwaredokumentation zu tun haben oder diese Aufgabe in Zukunft übernehmen wollen. Egal, ob du im Support arbeitest und regelmäßig Hilfetexte schreibst, als Entwickler:in oder Softwarearchitekt:in tätig bist und strukturiert an die Dokumentation herangehen möchtest, oder als Technische:r Redakteur:in die Verantwortung für klare, verständliche Anleitungen trägst – hier bist du richtig.

Auch wenn du neu in der Technischen Dokumentation bist oder dein Wissen auf den neuesten Stand bringen möchtest, bietet dieser Kurs dir genau die richtigen Grundlagen. Selbst wenn du schon Erfahrung hast, aber vor einer neuen Herausforderung stehst, wie der Einführung eines neuen Produkts, ist dieser Kurs perfekt, um frische, moderne Ansätze kennenzulernen. Kurz gesagt: Wenn du Software für andere verständlich machen willst, bist du hier genau richtig!

Der Kurs findet an vier halben Tagen jeweils von 09:00 - 13:30 Uhr statt.

1. + 28.01.2025 sowie 03.+04.02.2025

Host or Publisher STYRZ - Technische Redaktion e. K.