Moderne Softwaredokumentation, also eine ganzheitliche Nutzerassistenz, wird immer weniger mit Textverarbeitungssystemen erstellt und dann als PDF ausgeliefert…das ist nicht am Zahn der Zeit! Gute Softwaredokumentation ist modular sowie standardisiert aufgebaut und wird über mehrere Medien hinweg publiziert. Kurz: Hilfreiche Softwareinformationen sind nützlich und hilfreich, wenn sie dort bereitgestellt werden können, wo anwendende Personen diese erwarten – kontextsensitiv oder kontextabhängig im und um das Produkt herum.

Doch wie baut man gut strukturierte Informationsprodukte auf, die modular und standardisiert sind und worauf muss man achten, um wirklich hilfreiche Informationen bereitzustellen, ohne den Überblick über die enormen Mengen an kleinen Informationsschnipseln zu verlieren? Im Seminar lernst du Grundlagen didaktischer Konzepte, Informationsarchitekturen und der topicorientierten Softwaredokumentation kennen – gespickt mit vielen Übungen und Gesprächen, die dir dabei helfen, deine eigenen Informationsprodukte in Zukunft besser zu strukturieren.

Was dir unser Seminar bietet:

Durch unser Seminar erlernst du, wie du deine Informationsprodukte besser strukturieren kannst, wie du standardisierte Topics erstellst und vor allem wie du bestehende Anleitungen in standardisierte, hilfreiche und schnell scannbare Topics umbauen kannst. Zudem finden wir auf folgende Fragen Antworten im Seminar:

• Was ist „moderne“ Software Dokumentation?
• Was ist Single-Source-Publishing und warum ist das wichtig für herausragende Softwaredokumentation?
• Welche didaktischen Konzepte gibt es und wie kann ich die Informationsarchitektur für meine Informationsprodukte aufbauen?
• Was ist topicorientierte Strukturierung und welche Vorteile bringt sie?
• Wie kann ich meine Software-Dokumentation topicorientiert strukturieren?
• Was ist DITA und was hat das mit Softwaredokumentation zu tun?
• Wie kann ich meine Anleitungen besser strukturieren und worauf muss ich besonders achten?
• Was müssen wir für ganzheitliche Nutzerassistenz in Führung, Zusammenarbeit und Kommunikation verändern?

Sind diese Fragen auch Teil deines beruflichen Alltags? Dann bist du in unserem Seminar genau richtig!

In den vier halben Tagen werden 8 Lerneinheiten thematisiert und gemeinsam in praktischen Beispielen und Übungen erarbeitet. Dabei steht STYRZ sowohl für den fachlichen Input als auch für den intensiven Austausch in der Runde. Anhand der konkreten Schmerzpunkte der Teilnehmer:innen können wir in die Diskussion gehen und Lösungen erarbeiten. Die methodischen Werkzeuge bringen wir dir im Seminar bei und festigen das neu erworbene Wissen auf Basis konkreter Beispiele. Die 8 Themenfelder sind:

1. Grundlagen moderner Softwaredokumentation: Was ist moderne Softwaredokumentation und was ist Single-Source-Publishing? Warum ist das für herausragende Anleitungen für komplexe Softwareprodukte besonders wichtig.
2.  Informationsprodukte strukturieren: Welche Arten von Softwaredokumentation gibt es, wie werden diese didaktisch aufgebaut und wie können Informationsarchitekturen entwickelt werden.
3. Grundlagen topic-orientierter Strukturierung: Warum ist es wichtig, gute Softwareanleitungen topicorientiert zu strukturieren und was ist das überhaupt?
4. Modularisierung und Standardisierung: Jetzt wird es praktisch. Wie definiert man eigene Topic-Typen? Wir stellen Schritt für Schritt vor, wie du anhand von Methoden wie Information Mapping® oder Klassenkonzepttechnik (Closs, Sissi) zu deinen Topic-Typen kommst und üben das gemeinsam anhand von reelen Praxisbeispielen.
5. Grundlagen guter Anleitungen: Was zeichnet eine gute Anleitung inhaltlich aus und wie kann man diese Qualitätskriterien praktisch umsetzen?
6. Topic-Typen inhaltlich strukturieren: Wie schreibt man inhaltlich gute Anleitungen, Fehlerbeschreibungen, Learning-Nuggets und Release-Notes? Du lernst worauf es für gängige Topic-Typen ankommt und gemeinsam üben wir, wie du bestimmte Informationseinheiten in bestehenden Informationen identifizierst und in neue Strukturen überführst.
7. DITA im Kontext topicorientierter Softwaredokumentation: Was ist DITA und welche Topic-Typen gibt es in DITA? Wie kann ich diesen Standard für meine Informationsprodukte als Grundlage heranziehen oder leichtgewichtig mit DITA anfangen?
8. Vernetzen und Linken: Moderne Softwaredokumentation ist verteilt und vernetzt – die Informationshierarchien sind flach. Es braucht klare Verweiskonzepte, um die schnelle Auffindbarkeit von Informationen sicherzustellen. Wie baut man ein gutes Verweiskonzept auf und wie hilft das den lesenden Personen?

Du solltest das Seminar besuchen, wenn…

• Du zum Beispiel im Support tätig bist und deine Anwender:innen oft mit Hilfetexten unterstützt oder generell Anleitungen für deine Softwareoberflächen entwickelst
• Du die Rolle Softwareentwickler:in, Tester:in, Softwarearchitekt:in und/oder UX-Spezialist:in im Unternehmen trägst und du strukturiert und weniger „nach Gefühl“ an die Erstellung deiner Softwaredokumentation herangehen willst
• Du als Technische:r Redakteur:in bereits die Technische Dokumentation für deine digitalen Produkte erstellst und deinen Horizont erweitern möchtest
• Du als Technische:r Redakteur:in vor einer Neuentwicklung eines Produktes stehst und die Chance hast auch die Dokumentation “modern” zu gestalten

Online-Seminare, remote und doch ganz nah…

Unser Seminar findet digital statt – aber dennoch interaktiv. Dieses virtuelle Angebot ist ganz auf ein positives lernpsychologisches Didaktikkonzept ausgelegt. Im Vergleich zu Vor-Ort-Seminaren verteilen wir unsere Online-Veranstaltungen über mehrere Tage in kürzere Lerneinheiten aus Vortrag, Diskussion, Interaktion, Übung und Spaß am Thema. Durch die richtigen Tools, die wir in unseren Seminaren nutzen, kannst du interaktiv teilnehmen und mitwirken.

Eine Teilnahmebescheinigung für dein Wall-of-Fame im Büro oder Home-Office gibt’s auch. Wirkt sehr gut, versprochen.

Melde dich jetzt an und bringe deine Softwaredokumentation auf das nächste Level! Gerne kannst du uns vorab kontaktieren und wir beraten dich, ob das Seminar zu deinen Bedürfnissen passt.