Learn how to maintain control as a software architect in the age of coding agents.
🔎 Discover our new training: Architecture in the Context of Agentic Development.
socreatory training

Documentation-as-Code

Basics
2 Days
12
Seats
German and English
Online and in-person
Available on request

Also available as in-house training

We run this training exclusively for your team, online or on site.
In-house Offerings

Objectives

  • Use of lightweight text and graphic formats, seamless integration into the developer toolbox
  • Integration of documentation creation into automated build management
  • Creating meaningful diagrams and graphics
  • Regular output of documentation, geared towards target groups and in flexible formats
  • Avoiding redundancies, generating documentation from the source code and models
  • Collecting and incorporating feedback and seamless integration into software development processes

Curriculum

  • 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

Audience

This interactive workshop is aimed at anyone who wants to document software solutions to a high standard and has a technical background. This includes developers, architects and product managers. Participants have already gained practical experience in IT projects. Knowledge of a specific technology or programming language is not required.

Description

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.

Trainers

Falk Sippach

Software Architect and Consultant at embarc

Main Skills

Architecture reviews, Java expert

Ralf D. Müller

Trainer at socreatory

Main Skills

Docs-as-code, software documentation

More on this topic

Using Documentation-as-Code (Architecture Spicker No. 15)

Using the same tools and processes as in software development enables you to maintain documentation efficiently. This Spicker explains the idea and helps you to document your projects.

Falk Sippach
Stefan Zörner

In-house Training

You can also book this training as an in-house training course exclusively for your team. Please use the enquiry form for more details.

Enquire now

You may also like

iSAQB® training
Certificate

iSAQB® CPSA-A® ADOC

0
Technology
20
Methodology
20
Communication
Basics
Advanved
2 days
12
seats
German and English
Online and In-person
from 1,385.00 €

Frequently Asked Questions

What is the maximum number of participants in a training session?

For most training sessions, we limit the maximum number of participants to 12 per instructor. This allows us to ensure that you receive the best possible guidance.

Are meals provided during in-person training sessions?

Of course, we’ll take care of your meals during our in-person training sessions. We usually provide snacks twice a day and lunch. Drinks are also available.

Where can I find information about the training session I've already booked?

You can find all the information about your training in our socreatory Navigator. Here, in addition to useful links and information, you’ll find the specific location of the training for in-person sessions and the link to the video call for online sessions.

When and how will I receive my certificate of attendance after the training?

If you have attended at least 75% of the sessions, you will receive a certificate of attendance from us. You can download it from our socreatory Navigator a few days after the training.

Why socreatory?

Beyond the expertise of our trainers and our wide range of training courses, we offer even more compelling reasons to train with us.

All the benefits at your fingertips – download our program overview!

Unique Variety

We offer you the most comprehensive training program for software architecture in the German-speaking region – accredited and certified by iSAQB®.

Powerful IT expertise

Our experienced trainers are renowned experts in the industry and have co-developed 80 percent of the module curricula, both in terms of content and teaching methodology.

Hands-on learning experience

We are committed to providing interactive and engaging learning experiences, ensuring all participants can directly apply what they've learned.

Fair pricing model

The total price is reduced for as few as two participants from your company. Furthermore, you benefit from early bird pricing and enhanced planning certainty.

Looking for team training?

Unlock your team's potential with our specialized software architecture courses. We offer a variety of options, from in-depth iSAQB® training to customized workshops tailored precisely to your company's needs. Discover how these training programs can enhance your team's skills, and take advantage of attractive group and package discounts to maximize the value of your investment.