This July there's a trainings-special in Therme Erding for you – More information

Lightweight Architecture Documentation

Training iSAQB® CPSA®-Advanced ADOC — 2 days

Technology
Methodology20
Communication
Dates and Booking

Description

How to document and communicate software architecture?

Documentation as ballast? Effective documenting of the architecture helps you in the design of the software, manages the implementation and results in an understandable and assessable solution. Appropriate documentation supports interaction within the team and vis-à-vis third parties. In this interactive workshop you will learn how the documentation of the architecture changes from a burdensome duty to an integral communication and work tool. Learn to concisely document architecture-relevant influencing factors and important decisions.

iSAQB ADOC training

Agenda

  • Introduction and motivation: Which goals do you pursue with architecture documentation?

  • Minimal architecture overview: What should be included? How is it produced?

  • Ingredients of architecture documentation: decisions, concepts, diagrams …

  • Structure: advantage of templates, arc42, and alternatives

  • Process: target groups, selection of the components, documentation before vs. after

  • Tool selection: popular options, their strengths and weaknesses, typical challenges

  • Evaluation of documentation: Review of standard conformity vs. usability

Happy Participants

(24 ratings)

97% of all participants would recommend this training.

Your Benefits

Security in the documenting of solution approaches

Avoiding typical pitfalls, such as concerning scope and level of detail

Ballast-free architectural overviews

Many templates, checklists, and practical tips

Discussion on current tool trends in documentation

Audience

This workshop is aimed at anyone who designs and develops software solutions, or who is significantly involved in their creation, for example in the role of product owner. The participants already have practical experience in IT projects. Knowledge of a specific technology or programming language is not required. Knowledge of UML is helpful but not essential.

Training Objectives

Explain goals and benefits of architecture documentation

Determine scope, structure and approach according to the situation

Learn the standard notation and presentation tools

Appropriately document influencing factors

Produce meaningful representations

Document decisions transparently

Select tools and formats according to requirements

Give feedback on documentation results

Your Trainers

Stefan Zörner

embarc

Architekturdokumentation, Methodische Softwarearchitektur und Cloud-Anwendungen

Von der Bayer AG über IBM und oose zu embarc. Stefan Zörner blickt auf 20 Jahre IT-Erfahrung zurück und stets gespannt nach vorn. Er unterstützt in Architektur- und Umsetzungsfragen mit dem Ziel, gute Architekturansätze wirksam in der Implementierung zu verankern. In lebendigen Workshops vermittelt er Handwerkszeug dazu und steckt mit seiner Begeisterung an. Sein pragmatischer Ansatz Architektur festzuhalten findet großen Anklang.

Benjamin Wolf

INNOQ

Architecture documentation, software quality, software development process

Ben is an architect and a developer at INNOQ. He barely puts up with bad code and does not shy away from enormous refactorings. He shares his ideas of software quality and proper software development as trainer, consultant and speaker at conferences and meetups. It is important to him that we recognize that the attitude of a team is crucial for good software quality and far exceeds the value that is provided by technology alone. He is a certified trainer for the iSAQB Foundation level and the advanced level modules IMPROVE and ADOC.

Technical Information and Books

Softwarearchitekturen dokumentieren und kommunizieren

Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten. Das Buch von Stefan Zörner zeigt, wie ihr die zentralen Lösungsansätze Eurer Softwaresysteme so festhalten könnt, dass sie Euch bei der Entwicklung und Weiterentwicklung helfen. Dabei betrachtet er sowohl die Situation, dass ihr ein neues Softwaresystem baut, als auch das “Nachdokumentieren” bestehender Lösungen. Hanser Fachbuch, 3., überarbeitete und erweiterte Auflage (Dez 2021). Webseite zum Buch: swadok.de

The Architecture Overview (architecture cheat sheet No. 1)

You or your team are missing a compact overview of your existing software solution? You want to explain your architecture to new project members or cooperation partners? The source code is too »detailed« … The first edition of our Architecture cheat sheets supports you to get a high-level-overview of solution approaches in order to work effectively. Use the compact ingredients and fill your architecture overview with life – pragmatically and effectively. Download & Infos

arc42 by Example: Software architecture documentation in practice

Software architecture documentation in practice Packt Publishing 1. Auflage Oktober 2019, gemeinsam mit G. Starke und M. Simons, R.D. Müller ISBN: 978-1839214356

Softwarearchitekturen pragmatisch dokumentieren – Eine kompakte Einführung in arc42

Effektiv, schmerzfrei und mit wenig Aufwand. Gernot Starke und Benjamin Wolf räumen mit einigen Vorurteilen gegen (technische) Dokumentation auf und zeigen Dir, wie Du auf einfache Weise zu vernünftiger (Architektur-)Dokumentation kommst.

Online Courses

On-site Courses

Event ticketing software by pretix

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