Softwaredokumentation mit AsciiDoc

Einleitung

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.

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

• 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

Kursziel

Dieser eintägige Workshop wird bzgl. Softwaredokumentation mit Sicherheit viel zur Klarheit beitragen, neue Ideen liefern und bisher unbekannte Türen öffnen. Die Teilnehmer erfahren, wieso bisherige Versuche, die eigene Softwarearchitektur zu dokumentieren, im besten Fall nur kurzfristig funktionierten. In nur einem Tag können sich die Teilnehmer einen Überblick über die eindrücklichen Möglickeiten verschaffen, die sich mit einem Docs-as-Code- und Diagrams-as-Code-Ansatz ergeben.

Adressaten

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

Voraussetzungen

keine

Infrastruktur

Eigener Laptop mit Webbrowser