Motivation
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.
Insbesondere Entwickler sind neben der Nähe zwischen Programmcode und Dokumentation auch von der Fähigkeit überzeugt, die Markup-Rohdokumente unter Versionsverwaltung zu stellen und so die fertig formatierten Dokumente automatisiert über eine Build-Pipeline generieren und in verschiedene Formate exportieren zu lassen.
AsciiDoc ist für alle im Softwarebereich tätigen Personen die Sprache für effektive Softwaredokumentation und stellt mit ihren Möglichkeiten jedes Unternehmenswiki in den Schatten.
Programm
Der Schwerpunkt liegt im Kennenlernen und Üben von AsciiDoc als vereinfachte Auszeichnungssprache sowie dem Erzeugen ausgewählter Diagrammtypen aus textuellen Beschreibungen. Begleitet wird dies von lehrreichen Erläuterungen zum Wer, Wie und Was der Softwaredokumentation.
- Tag 1
- Bedeutung und Arten von Softwaredokumentation
- Docs as Code als nachhaltige Alternative zu Word und Confluence
- AsciiDoc als vereinfachte Auszeichnungssprache
- Textstrukturierung und -formatierung
- Klassische und spezielle Dokumentationsbausteine
- Einbinden von Code-Snippets und anderen Dokumenten
- Diagrams as Code als textuelle Alternative zum «Kästchenschieben»
- Ausblick auf Dokumentationsvorlagen und automatische Verifizierung von Architekturvorgaben
mittels ausführbarer Dokumentation
Kursziele
Dieser eintägige Workshop wird bzgl. 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. In nur einem Tag können Sie sich einen Überblick über die eindrücklichen Möglickeiten verschaffen, die sich mit einem Docs-as-Code- und Diagrams-as-Code-Ansatz ergeben.
Zielgruppen
- Alle im Softwarebereich tätigen Personen (Entwickler, Architekten, Projekt- und Produktmanager, Abteilungs- und Teamleiter, Entscheider etc.)
Referent
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 unterrichtet bzw. doziert seit 12 Jahren u. a. im Bereich der Java- und Python-Programmierung, Mathematik und Algorithmik. Er schreibt regelmässig Artikel für IT-Fachzeitschriften.
Kurzlink auf diese Seite: link.simplexacode.ch/nj382023.05