Docs-as-Code (online) - Ralf Müller, Falk Sippach - Deutsch
Architecture documentation is very often neglected. There are many reasons for this, including the use of impractical tools and formats. With the docs-as-code approach, documentation is treated like source code. Documents are created in lightweight text and graphic formats, stored close to the source code in Git repos, for example, and versioned and processed in automated build processes. Based on lean tools and markup languages, this seminar shows how to create documentation that is as redundancy-free as possible, optimized for different target groups and can be continuously delivered in appealing formats.
Agenda
- Introduction to Documentation-as-Code and our case study
- Storage in the version management system
- Necessary tools and integration into build management
- Use of markup languages
- Modularization of documentation
- Effective creation of diagrams (PlantUML, Kroki.io, Diagrams.net, …)
- Creation of target group-oriented result formats
- Integration of existing information to avoid redundancies (source code, models, …)
- Further topics such as microsites and import and export formats
Your Trainers
Falk Sippach
embarc
Architecture reviews, Java expert
- Agile Software Architecture
- Application Programming Interfaces
- 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.