19 November 2020

Ralf is a Software Engineering Advocate at DB Systel GmbH during the day and after sunset he loves everything with bits and bytes. The last few years of his career, he focused on the documentation of software systems with arc42 and the Docs-as-Code approach.

You can follow him on mastodon rdmueller@mastodontech.de.

api?username=rdmueller&show icons=true

small2x?1549481171 This book contains several real-world software architectures, documented with the practical arc42 template.

You will learn about the inner workings of a chess engine, a huge CRM system, a cool web system to track biking activities and an extremely small menu-bar application.

Each of the examples starts with a brief description of the problem domain, including the quality requirements, before we explain the system context with all the external interfaces. Then we dive into an overview of the solution strategy to prepare you for the implementation building blocks and runtime scenarios (as major architectural views).

Later on we explain the crosscutting concepts of every architecture and its implementation.

You will learn that documentation can be compact, helpful and easy-to-read.

small2x?1549506199 Dieses Buch hilft Ihnen bei der pragmatischenErstellung und Pflege der Dokumentation von Software.Es zeigt Ihnen, was der Docs-as-Code Ansatz ist und wie Sie ihn umsetzen und somit Ihre Dokumentation genau so behandeln, wie den Quelltext Ihrer Software.Dabei gehen wir über das einfache Verwalten von Texten mit Softwareversionierung hinaus und zeigen Ihnen, wie Sie z. B. auch Grafiken und Diagramme ohne viel Mühe aktuell halten und Ihre Dokumentation in den Test- und Releasezyklus Ihrer Software einbinden.

Hinweis: In diesem Buch geht es nicht primär darum den Umgang mit bestimmten Tools zu vermitteln.Das Buch enthält zwar viele Beispiele und nutzt dazu das Open-Source-Projekt docToolchain.Viel wichtiger ist jedoch, dass dieses Buch den Docs-as-Code Ansatz vermittelt und Ihnen hilft eine entsprechende Denkweise und Kultur für Ihre tägliche Arbeit zu entwickeln.

Things I like and use

  • Operating System

    • Windows 10 with WSL2

    • Linux

  • Programming

    • Groovy

    • IntelliJ

  • Documentation

    • docToolchain

    • AsciiDoc / AsciiDoctor

    • PlantUML

    • Diagrams.net

    • Sparx Enterprise Architect

  • Security

    • oAuth2

  • Video

    • OBS

    • OBS.ninja

    • Camtasia (video cut)

  • Spare time

    • Ender 3 3D Printer with Octoprint

    • Raspberry Pi

    • Arduino

    • Retro Gaming (Atari)

    • Halfbike

  • cool presentation: https://bentolor.github.io/java17-lts-presentation/#/