ADOC (Karlsruhe) - Stefan Zörner - German
How to document and communicate software architecture?
Create and maintain clear and comprehensive architecture documentation. Choose appropriate formats and tools—from arc42 to GenAI—to achieve an optimal balance between effort and benefit.
Documentation as ballast? Effective documenting of the architecture helps you in the design of the software, manages the implementation and results in an understandable and assessable solution. Appropriate documentation supports interaction within the team and vis-à-vis third parties. In this interactive workshop you will learn how the documentation of the architecture changes from a burdensome duty to an integral communication and work tool. Learn to concisely document architecture-relevant influencing factors and important decisions.
We’ll also take a look at generative AI: Where do GenAI tools provide real added value in creating, maintaining, and using architecture documentation—for example, when generating documentation from source code or answering questions about existing documentation? And where should we exercise caution? The training follows the current iSAQB curriculum (2025.1), which incorporates the use of GenAI in architecture documentation as a learning objective.
The basis for the seminar is the book “Softwarearchitekturen dokumentieren und kommunizieren - Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten” (Hanser Verlag, 3rd edition) by our trainer Stefan Zörner. The book is included in the seminar price for each participant (hardback and eBook).
Agenda
- Introduction and motivation: Which goals do you pursue with architecture documentation?
- Minimal architecture overview: What should be included? How is it produced?
- Ingredients of architecture documentation: decisions, concepts, diagrams …
- Structure: advantage of templates, arc42, and alternatives
- Process: target groups, selection of the components, documentation before vs. after
- Tool selection: popular options, their strengths and weaknesses, typical challenges
- GenAI in Documentation: Practical Use Cases, Tool Support, and Validating Results
- Evaluation of documentation: Review of standard conformity vs. usability
Your Trainers
Stefan Zörner
embarc
Architecture documentation, methodical software architecture and cloud applications
- Architecture Evaluation
- CPSA Foundation Level
- Flexible architectures
- Lightweight Architecture Documentation
- Lightweight Software Reviews with LASR
From Bayer AG to IBM to embarc. Stefan Zörner looks back on 25 years of IT experience and always looks forward with excitement. He provides support in architecture and implementation issues with the aim of effectively anchoring good architecture approaches in the implementation. In lively workshops, he teaches the tools of the trade and is infectious with his enthusiasm. His pragmatic approach to architecture is very well received.