Ausgezeichnete Softwaredokumentation

BESCHREIBUNG

Dieses zweitägige Seminar 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 sowie Antora als perfekt dazu passenden Dokumentationsgenerator. Sie erleben, wie ausgewählte Diagrammtypen aus textuellen Beschreibungen erzeugt werden können und das Erscheinungsbild gesamter Dokumentationsstrukturen zentral angepasst werden kann. Begleitet wird all das von lehrreichen Erläuterungen zum organisatorischen Wer, Wie und Was der Softwaredokumentation.

Warum Sie diese Schulung besuchen sollten:

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.

Ausgezeichnete Softwaredokumentation gelingt durch einen ganzheitlichen Ansatz aus a) vereinfachter Auszeichnungssprache, b) Dokumentationsgenerator und c) einfach umsetzbaren organisatorischen Massnahmen – also genau das, was Sie in diesem Seminar lernen werden.