Softwaredokumentation mit AsciiDoc
2024-09-02 , Room A

Der grossen Bedeutung von Softwaredokumentation lässt sich heute mit zeitgemässeren Umgebungen als Word oder Confluence begegnen.

Mit einer vereinfachten Auszeichnungssprache – hier AsciiDoc – lassen sich die Dokumente nämlich in jedem beliebigen Texteditor erstellen und bearbeiten. Dabei bleiben alle Inhalte und Konfigurationen einfach lesbar und editierbar, und das ganz ohne eigenwillige WYSIWYG-Programme oder Wiki-Plattformen.

Softwareentwickler schätzen die Nähe zwischen Programmcode und Dokumentation sowie die Möglichkeit, die Rohdokumente direkt unter Versionsverwaltung zu stellen. Leser aller Zielgruppen schätzen das professionelle, einheitliche und gepflegte Erscheinungsbild einer so generierten Dokumentationsstruktur.


Dieser Workshop wird in Sachen Softwaredokumentation mit Sicherheit viel zur Klarheit beitragen, neue Ideen liefern und bisher unbekannte Türen öffnen. Sie erfahren, wieso bisherige Versuche, die eigene Softwarearchitektur zu dokumentieren, im besten Fall nur kurzfristig funktionierten. Anhand vieler eigenhändiger praktischer Beispiele können Sie sich einen Überblick über die eindrücklichen Möglichkeiten verschaffen, die sich mit einem Docs-as-Code- und Diagrams-as-Code-Ansatz ergeben.

Der Schwerpunkt liegt im Kennenlernen und Üben von AsciiDoc als vereinfachte Auszeichnungssprache. Begleitet wird all das von lehrreichen Erläuterungen zum organisatorischen Wer, Wie und Was der Softwaredokumentation.


Target audience:

Alle im Softwarebereich tätigen Personen (Entwickler, Architekten, Projekt- und Produktmanager, Abteilungs- und Teamleiter, Entscheider etc.)

Aim of the workshop:

Das Ziel des Workshops ist es, die Teilnehmenden schnell und effektiv in die Nutzung von AsciiDoc für Softwaredokumentation und darüber hinaus einzuführen. Sie lernen, wie mit dieser vereinfachten Auszeichnungssprache sowohl technische Dokumentationen als auch Inhalte ausserhalb des Softwarebereichs klar, professionell und konsistent gestaltet werden. Kurz gesagt: Nach diesem Kurs können die Teilnehmenden AsciiDoc anwenden, um Ihre Dokumentationsprozesse zu vereinfachen und zu verbessern – unabhängig vom Anwendungsbereich.

Requirements:

keine

Infrastructure:

Eigener Laptop mit beliebiger IDE oder Webbrowser

𝗭𝘂𝗿 𝗔𝗻𝗺𝗲𝗹𝗱𝘂𝗻𝗴: https://eventfrog.ch/de/p/kurse-seminare/computer-edv/softwaredokumentation-mit-asciidoc-7200444695985491142.html

Christian Heitzmann ist Java-, Python- und Spring-zertifizierter Softwareentwickler mit einem CAS in Machine Learning und Inhaber der SimplexaCode AG in Luzern. Er entwickelt seit über 20 Jahren Software und gibt seit über 12 Jahren Unterricht und Kurse im Bereich der Java- und Python-Programmierung, Mathematik und Algorithmik. Als Technical Writer dokumentiert er Softwarearchitekturen für Unternehmen und schreibt regelmässig Artikel für IT-Fachzeitschriften.

This speaker also appears in: