Open Education Day 2024

Docs as Code mit AsciiDoc – Eine officefreie Open-Source-Auszeichnungssprache für Unterricht, Studienarbeiten und Softwaredokumentation (inkl. Pause)
04.05.2024 , Fab8: B205
Sprache: Deutsch

Entdecken Sie Docs as Code mit AsciiDoc: einfache Dokumentenerstellung in einer Auszeichnungssprache, weg von komplexen Office-Programmen. Der Ansatz ermöglicht programmierähnliche Dokumente, ideal für Schulen (Einführung in «Programmierung»), das Hochschulstudium (von der Semester- bis zur Doktorarbeit) und effektive Softwaredokumentation im Softwarebereich. In meiner Session zeige ich, wie dieser Ansatz die herkömmlichen Methoden übertrifft. Bringen Sie Ihre Laptops mit, um Docs as Code und AsciiDoc live zu erleben!


Dokumente in vereinfachten Auszeichnungssprachen lassen sich mit jedem beliebigen Texteditor erstellen und bearbeiten, denn ihre schlichte Syntax ist für Mensch und Maschine gleichermassen gut lesbar. Die Rohdokumente lassen sich wie Programmcode unter Versionsverwaltung stellen. Ein Dokumentationsgenerator generiert und verlinkt die jeweils fertig formatierten Dokumente in Sekundenschnelle und exportiert sie bei Bedarf auch in verschiedene Formate.

Dieser gemeinhin als «Docs as Code» bezeichnete Ansatz verzichtet vollumfänglich auf WYSIWYG-Office-Textverarbeitungsprogramme und all seine Nachteile. Stattdessen bietet das stets im Quellcode vorliegende Dokument unmittelbare Einsehbarkeit in alle «Einstellungen». Salopp gesagt werden die Dokumente also eher programmiert statt «zurechtgeklickt» – im Prinzip wie HTML, nur einfacher.

• Für den Schulunterricht stellt dieser Ansatz eine hervorragende Möglichkeit dar, um vom reinen Office-Anwendungsunterricht loszukommen und eine behutsame Einführung in die Welt der «Programmierung» (mit einer Auszeichnungssprache) zu ermöglichen.
• Für das Hochschulstudium ist AsciiDoc eine ideale Sprache zum Schreiben von Studienarbeiten – bei Weitem nicht so kompliziert wie LaTeX, dafür immer noch mit mathematischem Formelsatz.
• Für alle im Softwarebereich tätigen Personen (Entwickler, Architekten, Projektleiter, Produktverantwortliche und alle anderen Entscheider) ist AsciiDoc die Sprache für effektive Softwaredokumentation und stellt mit seinen Möglichkeiten jedes Unternehmenswiki in den Schatten.

Teilnehmer benötigen einen eigenen Laptop mit Webbrowser, wenn sie AsciiDoc gleich vor Ort ausprobieren möchten.


Kategorie:
  1. Open Source Software Anwendungen
Zielgruppen:

Lehrpersonen / Dozierende, Bildungsverantwortliche, Schulleitungen, IT-Verantwortliche, Forschende, Interessierte, 3. Zyklus (Sek I), Sekundarstufe II (Gymnasium, FMS, BMS), Tertiärbildung (Hochschulen, Erwachsenenbildung, ...)

Siehe auch: Workshop Unterlagen:

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.