AsciiDoc Deep Dive
Mit AsciiDoc kann Dokumentation im gleichen Repository wie der Quellcode des Programms eingecheckt werden. Damit kann die Dokumentation in AsciiDoc zusammen mit der Funktionalität im Code mit jeder umgesetzten User-Story mitwachsen.Für IDEs gibt es Plug-ins, die eine Vorschau für die erstellten Texte ermöglichen und Refactorings der erstellten Dokumente erlauben. Der Continuous-Integration-Server erstellt anschließend aus den AsciiDoc-Dateien die HTML- oder PDF-Dokumente für die Nutzer.
Dieser Vortrag geht in die Details und beantwortet folgende Fragen:
- Wie setze ich komplexe Formatierungen um?
- Wie strukturiere ich große Dokumente?
- Wie formatiere ich PDFs?
- Wie kann mich meine IDE unterstützen?
Vorkenntnisse
- Erfahrungen in der Softwareentwicklung und der damit einhergehenden Dokumentation
- Erste Erfahrungen mit AsciiDoc oder einer vergleichbaren Markup-Sprache
Lernziele
- Möglichkeiten und Chancen von Documentation-as-Code erkennen können
- Praktische Beispiele, Best-Practices und Fallstricke kennenlernen
Speaker
Alexander Schwartz ist Principal Software Engineer bei Red Hat. Außerdem ist er Maintainer des AsciiDoc-Plug-ins für IntelliJ und hat praktische Erfahrungen in mehreren Projekten damit gesammelt. Auf Konferenzen und bei User Groups berichtet er regelmäßig über dieses Thema. Für Red Hat ist er Teil der Eclipse Working Group zur Standarisierung zu AsciiDoc.
betterCode-Newsletter
Du möchtest über die betterCode() ArchDoc und weitere unserer betterCode()-Events auf dem Laufenden gehalten werden?