Documentation-as-Code

2 Days

Dates and Booking

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.

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 Benefits

Modern, effective and pragmatic documentation of the software architecture

Simple creation and maintenance thanks to lightweight tools

Visually appealing and easy-to-maintain diagrams and graphics

Target group-oriented combination of redundancy-free and generated content

Import information from existing sources and export to document management systems

Integration of documentation creation into collaborative software development processes

Continuous delivery of documentation that is always up to date

Exchange on current trends in tools and markup languages

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.

Training 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

Your Trainers

Falk Sippach

embarc

Architekturbewertungen, Java Experte

  • Agile Software Architecture
  • CPSA Foundation Level
  • Documentation-as-Code
  • Evolution and Improvement of software architectures
  • Fantastic diagrams
  • Flexible architectures

Als Trainer, Berater und Architekt ist Falk stets auf der Suche nach dem Funken Leidenschaft, den er bei seinenTeilnehmern, Kunden und Kollegen entfachen kann. Bereits seit über 15 Jahren unterstützt er in meist agilen Softwareentwicklungsprojekten im Java-Umfeld, anfangs als Entwickler, später als Projektleiter, Architekt und Coach. Falk ist überzeugt, dass lebenslanges Lernen die Voraussetzung für die berufliche Selbstentfaltung und dauerhafte Freude am Tun ist. Trotz der Begeisterung für Neues behält er immer auch die Menschen und gewachsene Strukturen im Blick, um ausgewogene Lösungen entwickeln zu können. Als aktiver Bestandteil der Community teilt er 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. Video: Was ist eigentlich Documentation as Code? Falk erklärt es euch im Stream mit Lisa Moritz.

Ralf D. Müller

Docs-as-Code, Softwaredokumentation

  • Documentation-as-Code
  • Fantastic diagrams
  • Prompt engineering for architects and developers

Ralf hat in über 25 Jahren in der Softwarebranche seine Fähigkeiten kontinuierlich verbessert und sich vom Softwareentwickler zum erfahrenen Software-Architekten entwickelt. Neben dem Design von Softwarearchitekturen legt er großen Wert auf die klare Kommunikation und Dokumentation seiner Ideen. Mit diesem Ziel vor Augen hat Ralf das Open-Source-Projekt docToolchain ins Leben gerufen, das sich mit der effektiven Dokumentation von Softwarearchitekturen beschäftigt. Er ist auch verantwortlich für die Erstellung der verschiedenen Formate des arc42 Templates. Als CPSA-Advanced-zertifizierter Softwarearchitekt teilt Ralf sein Wissen und seine Erfahrung in Schulungen und Vorträgen, um anderen zu zeigen, wie sie Architekturdokumentation einfach und aktuell halten können. Video: Mehr als Pfeile und Kästchen – Architekturdiagramme im Softwarearchitektur-Stream.

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

Relevant Other Training Courses