Documenting and Communicating Modern Software Architectures
summary
The talk explains how to create and maintain pragmatic, up-to-date software architecture documentation using lightweight tools and text/graphics formats (Documentation as Code). It covers replacing heavyweight UML/Wiki approaches with automatable, redundancy-free documentation that integrates into development and review processes and can be produced in different formats for different audiences.
AI-written summary · about
chapters (19)
- 0:00Introduction
- 2:05Mission Statement for this Talk
- 7:53Our Daily Developer Bread
- 8:18Documentation-as-Code
- 10:20Continuous Documentation
- 14:31Trees for the Forest...
- 14:45Architecture Design
- 15:21What is an Architecture Overview?
- 17:50Architecture CWA: Informal Overview Diagram
- 18:23Context Boundary
- 20:24Central Constraints of the CWA
- 20:56Influences on Decisions
- 21:45Top Quality Goals of the Corona-Warn-App
- 23:22Filing in arc42
- 25:29A Maturity Model
- 35:33Modular Documentation
- 40:54Collaboration
- 44:14Docs-as-Code in the IDE
- 47:52Conclusion and Outlook
related talks
46mBest Practices for Keeping Architecture Documentation Up to Date
45mFive things every developer should know about software architecture
42mC4 — A Lightweight Approach to Documenting Architecture
11mBuilding an Architecture Documentation Framework from Scratch
30m5 Things Every Developer Should Know about Software Architecture
39mWe're Agile, we don't do documentation
47mDocumentation, it is alive!
45mDemocratising Software Architecture