Tech-Talk - Docs as Code

In diesem Tech-Talk möchte ich am Beispiel von Asciidoctor zeigen, wie eine zeitgemäße Alternative zu klassischen Dokumentationswerkzeugen aussehen kann, wie sie funktioniert, und wie sich Dokumentation als Code nahtlos in den Softwareentwicklungsprozess einbinden lässt. Besonderns in agilen Projekten ermöglicht dieser Ansatz eine kontinuierliche, effiziente und nachhaltige Pflege der Dokumentation. Im Fokus stehen zudem die Möglichkeiten zur Einbindung von Grafiken, Diagrammen und Quellcode sowie die vorhandene Tool-Unterstützung im täglichen Einsatz.

Zielgruppe:

für alle technisch Interessierten

Voraussetzung:

Interesse an technischen IT Themen

Ziele/Nutzen des Seminars:

Diese rein virtuellen Veranstaltungen bieten spannende Vorträge und Deep Dives zu aktuellen Themen aus der IT-Praxis. Dabei geben Experten detaillierte Einblicke in ihre Arbeit, stellen sich den Fragen des Publikums und diskutieren zu ausgewählten Schwerpunktthemen. Die Teilnahme am Event ist kostenlos.

Inhalte:

• AsciiDoc, Asciidoctor, AsciidoctorJ
• Eine Beispiel-dokumentation
• Syntax von AsciiDoc
• Diagramme
• Maven-Plugin
• Output PDF, HTML
• Quellcode in AsciiDoc einbinden
• Code in Textfluss einfügen
• Code als Block einfügen
• Code per Include-Anweisung referenzieren
• Code-Auszüge mit Tags referenzieren
• Eclipse Asciidoctor Editor