In der Welt der Software-Entwicklung steht die Qualität und Nachhaltigkeit von Projekten und Produkten oft im direkten Zusammenhang mit einem Element, das häufig unterschätzt wird: der Software-Dokumentation. Trotz ihrer entscheidenden Bedeutung begegnet sie regelmäßig Vorurteilen und vermeintlich schlechten Erfahrungen.

Dieser Talk zeigt auf, dass und wie es heute besser geht. Wir beginnen mit einem klaren Blick auf die technischen und wirtschaftlichen Folgen unzureichender Dokumentation und widerlegen weit verbreitete Ausreden von Entwicklern und Entscheidern. Anschließend gehen wir darauf ein, wie sich die Bedürfnisse unterschiedlicher Zielgruppen und die verschiedenen Abstraktionsebenen voneinander abgrenzen lassen und so in verschiedenen Dokumentationsarten resultieren.

Ein zentrales Element für gelingende Software-Dokumentation ist die effektive Nutzung von "vereinfachten Auszeichnungssprachen" (daher auch das Wortspiel im Titel) sowie die Einführung eines "Docs-as-Code"- und "Diagrams-as-Code"-Ansatzes, unterstützt durch akzeptierte Werkzeuge, Methoden und Ablagesysteme. Diese Ansätze ermöglichen es, Dokumentation und Grafiken effizient und automatisiert zu erstellen, zu verwalten und zu aktualisieren, ähnlich wie bei Quellcode.

Die vielen Vorteile einer solchen Methode liegen auf der Hand. Zum Schluss lernen Sie einfach umsetzbare organisatorische Massnahmen kennen, die den Unterschied zwischen dem Scheitern und dem Erfolg Ihres Dokumentationsvorhabens ausmachen. "Ausgezeichnete" Softwaredokumentation gelingt durch einen ganzheitlichen Ansatz aus

   a) vereinfachter "Auszeichnungs"sprache,

   b) Dokumentationsgenerator und

   c) einfach umsetzbaren organisatorischen Massnahmen

– also genau das, was Sie in diesem Talk hören und in Form von praktischen Demonstrationen sehen werden.

Vergessen Sie alle Vorurteile und schlechten Erfahrungen, die Sie über Software-Dokumentation gehört haben. Nach dieser Präsentation können Sie es besser machen!