Description
The most important task of a software architect is to communicate the architecture. In addition to textual content, it is also important to create graphics. True to the motto “A picture is worth a thousand words”, diagrams help with effective and pragmatic documentation. To be effective, they must be easy to understand, always up-to-date and correct.
In this workshop, we will first identify the weak points of many diagrams and then consider how we can work around them. The result is a checklist for really good, almost fantastic architectural diagrams. As a bonus, we will show you how to implement maintainable diagrams using the docs-as-code approach to keep them up to date and in line with the architecture at all times.
Agenda
- Problems/weaknesses of diagrams
- Diagrams-as-code
- Views in the software architecture
- Tools and embedding in architecture documentation
Audience
This interactive workshop is aimed at anyone who wants to document software solutions to a high standard and has a technical background: Developers, architects and product managers. Participants should already have practical experience in IT projects. Knowledge of a specific technology or programming language is not required.
Your Trainers
Falk Sippach
embarc
Architecture reviews, Java expert
- Agile Software Architecture
- CPSA Foundation Level
- Documentation-as-Code
- Evolution and Improvement of software architectures
- Fantastic diagrams
- Flexible architectures
As a trainer, consultant and architect, Falk is always on the lookout for the spark of passion that he can ignite in his participants, customers and colleagues. He has been supporting mostly agile software development projects in the Java environment for over 15 years, initially as a developer and later as a project manager, architect and coach. Falk is convinced that lifelong learning is the prerequisite for professional self-development and lasting enjoyment in what you do. Despite his enthusiasm for new things, he always keeps an eye on people and established structures in order to develop balanced solutions. As an active member of the community, he likes to share his knowledge in articles, blog posts and presentations at conferences or user group meetings and supports the organization of various specialist events. Video: What is Documentation as Code? Falk explains it to you in the stream with Lisa Moritz.
Ralf D. Müller
Docs-as-code, software documentation
- Documentation-as-Code
- Fantastic diagrams
- Prompt engineering for architects and developers
Ralf has continuously refined his skills over more than 25 years in the software industry, evolving from a software developer to an experienced software architect. In addition to designing software architectures, he places great emphasis on clearly communicating and documenting his ideas. With this goal in mind, Ralf initiated the open-source project docToolchain, which focuses on the effective documentation of software architectures. He is also responsible for creating various formats of the arc42 template. As a CPSA-Advanced-certified software architect, Ralf shares his knowledge and experience in training sessions and talks, showing others how to keep architectural documentation simple and up-to-date. Video: More Than Arrows and Boxes – Architecture Diagrams in Software Architecture Stream..
Relevant Other Training Courses
Lightweight Architecture Documentation
How to document and communicate software architecture?
Technology —Methodology 20Communication —from 1,350 €
iSAQB® Module ADOC
If you want to delve deeper into the topic of architecture documentation, this is the right topic for you.
Documentation-as-Code
Practical implementation of software architecture documentation with developer tools
by Request
Would you like to establish the Docs as Code approach in your team and are looking for a practice-oriented training course? Then you've come to the right place.