Best Practices für (Architektur)dokumentation - Falk Sippach

Software Testing - Qualität, Testautomatisierung & Agilität

Dokumentation als Code

“Documentation as Code ist die Idee, dass wir die Dokumentation wie Source Code behandeln, also die selben Werkzeuge nutzen können und das Ganze auch in Build-Prozesse integrieren, automatisieren können.” - Falk Sippach

In dieser Folge sprechen wir über die Bedeutung und Methoden einer effizienten Architekturdokumentation. Dabei thematisieren wir, wie Dokumentation oft vernachlässigt wird und welche Lösungen es gibt, um dies zu vermeiden. Die Ansätze 'Documentation as Code' und 'Continuous Documentation' ermöglichen es, Dokumentation wie Quellcode zu behandeln und kontinuierlich zu aktualisieren. Zudem befassen wir uns mit der Nutzung von Tools wie Markdown und ASCII-Doc, die den Prozess der Erstellung und Pflege von Dokumentationen erleichtern. Anhand zahlreicher praktischer Beispiele und Tipps wird verdeutlicht, wie Entwickler und Tester ihre Dokumentation leichtgewichtig und effektiv gestalten können.

Falk Sippach ist als Softwarearchitekt, Berater und Trainer stets auf der Suche nach dem Funken Leidenschaft, den er bei seinen Teilnehmern, Kunden und Kollegen entfachen kann. Bereits seit 20 Jahren unterstützt er in meist agilen Softwareentwicklungsprojekten im Java-Umfeld. Als aktiver Bestandteil der Community (Mitorganisator der JUG Darmstadt und Mitglied der Java Champions) teilt er zudem sein Wissen gern in Artikeln, Blog-Beiträgen, sowie bei Vorträgen auf Konferenzen oder User Group Treffen und unterstützt bei der Organisation diverser Fachveranstaltungen.

Highlights:

• Dokumentation ist für Tester wichtig als Testbasis und Nachschlagewerk.
• Falk erklärt, wie Dokumentation oft vernachlässigt wird und warum das so ist.
• Documentation as Code bedeutet, Dokumentation wie Source Code zu behandeln und in Textformaten wie Markdown oder ASCII-Doc zu schreiben.
• Continuous Documentation integriert die Dokumentation in den gesamten Entwicklungsprozess, ähnlich wie Continuous Integration und Continuous Delivery.
• Integration von Bildern und Diagrammen in die Dokumentation

Links:

• http://www.sippsack.de
• https://www.linkedin.com/in/falk-sippach-845259114/
• https://www.software-testing.fm

Danke an die Community-Partner des Podcasts:

• Alliance for Qualification: https://swt.fm/a4q
• ASQF: https://swt.fm/asqf
• Austrian Testing Board: https://swt.fm/atb
• dpunkt.verlag: https://swt.fm/dpv
• German Testing Board: https://swt.fm/gtb
• German Testing Day: https://swt.fm/gtd
• GI Fachgruppe TAV: https://swt.fm/tav
• Heise: https://swt.fm/hei
• HANSER Verlag: https://swt.fm/chv
• ISTQB: https://swt.fm/ist
• iSQI GmbH: https://swt.fm/isqi
• oop: https://swt.fm/oop
• QS-TAG: https://swt.fm/qst
• SIGS-DATACOM: https://swt.fm/sigs
• skillsclub: https://swt.fm/sc
• Software Quality Days: https://swt.fm/swqd
• Swiss Testing Board: https://swt.fm/stb

Credits:

• Sound: https://swt.fm/krz
• Grafik: https://swt.fm/kdb

Fejezetek

1. Einführung und Bedeutung der Architekturdokumentation (00:00:00)

2. Herausforderungen bei der Dokumentation (00:02:28)

3. Ansätze zur Verbesserung der Dokumentation (00:05:50)

4. Einführung in die Architekturdokumentation (00:11:09)

5. Vorteile von DrawIO und Diagramms as Code (00:12:09)

6. Continuous Documentation und Automatisierung (00:15:00)