Architecture Communication Canvas – Useful Documentation in less than 60 Minutes

Updated version of the original Canvas presentation

Transcript

1. Architecture Communication Canvas Useful Architecture Documentation in 60 45 Minutes BENJAMIN WOLF @BEN@INNOQ.SOCIAL Photo by Raychan on Unsplash
2. „Jedes Problem lässt sich mit gutem Kaffee lösen.“ Benjamin Wolf Coffee Consultant bei INNOQ Consultant für Architekturentwicklung / -dokumentation Trainer für iSAQB Foundation, IMPROVE und ADOC arc42-Fan und -Maintainer Kaffeegenussspecht
3. Why this topic?
4. The Endless Void ... Photo by Rubén Bagüés on Unsplash
5. Nobody Finds a Thing image by DALL.E
6. Documentation as Denial-of-Service Attack https://wiki.eclipse.org/EclipseLink/Development/Architecture/EclipseLink/ClassDiagram
7. Assumption You • need* to document • have limited time * if we were younger and naive, we would have written „want“
8. Agenda ACC arc42 in a nutshell What is a Canvas?
9. Agenda ACC arc42 in a nutshell What is a Canvas?
10. once upon a time… best research system for authors online news media - php - old linux version structure daily content J Smith PO A Markov CTO - newsfeed aggregator comp - news validator comp - news summarizing comp J Smith PO A Markov CTO people leaving lib updates too often int news aggregato r - java - TS - node - headline viewer - layout preview Security advisory CSO DIY sec considered bad practice all libs and OS Github bot - Python - Bash - make - scanner - owasp-10 reader -
11. wtf? Can-what? Photo by Kari Shea on Unsplash
12. what? Canvas [en: KannWas] Photo by Kari Shea on Unsplash
13. explained by chatGPT 3 Canvas (1) k c o l B https://chat.openai.com/share/ce9455a9-4d17-4e32-a590-a53136ea481a In software engineering, a D i r canvas typically refers to a R t *!$§* E e NO P visual container where users can interact and manipulate elements to create or modify content.
14. explained by us Canvas (2) ... A canvas is a structured D i visualization that r R t E k e c P YES! o facilitates understanding l B and analysis of key elements of specific topics..
15. Business Model Canvas k c o l B https://www.strategyzer.com/books i r t e P E WOW! D R
16. https://www.projectwizards.net/en/blog/2019/09/business-model-canvas Business Model Canvas k c o l B i r t e P E D R
17. Business Model Canvas k c o l B i r t e P E D R
18. Bounded Context Canvas k c o l B i r t e P E D R
20. many more … https://canvanizer.com
21. Why not … create our own canvas?
22. Software Architecture Canvas
23. Oh, snap!! https://www.workingsoftware.dev/software-architecture-canvas/
24. Thanks, Patrick! What should the software do? How can we achieve it? for new systems How do we evaluate the situation? https://canvas.arc42.org/architecture-inception-canvas
25. Agenda ACC arc42 in a nutshell What is a Canvas?
26. arc42 has 12 “shelves”
27. arc42 in a nutshell 1. Introduction and Goals 1.1 Requirements Overview 1.2 Quality Goals Main requirements, especially quality goals 8. Crosscutting Concepts 3. System Scope and Context -> external interfaces Neighbouring systems and external interfaces 9. Architecture Decisions 4. Solution Strategy 1. Introduction and Goals 7. Deployment View 2. Constraints 3. System Scope and Context 4. Solution Strategy 10. Quality Requirements Core idea of the solution, suggestion: bullet points only 5. Building Block View Top-level structure of the code 8. Crosscutting Concepts Cross-cutting concepts, highly detailed 9. Architecture Decisions Important architecture decisions, incl. decision makers and date 5.1. Whitebox Overall System (Level 1) 5. Building Block View 11. Risks & Technical Debt 6. Runtime View 12. Glossary 29
28. Agenda ACC arc42 in a nutshell What is a Canvas?
29. Structure of the Canvas
30. k c o l B https://canvas.arc42.org i r t e P E D R
31. Use Canvas for: Reviews • Create canvas prior to review • Common understanding • Remind participants of „everything“
32. Use Canvas to: Kickstart • Fastest possible start • Avoid blank-paper syndrome
33. Use Canvas in: an Emergency • Fastest possible documentation • If nothing else works…
34. ACC Examples
35. Health-Insurance Card
36. Salary Management
38. ACC Experience Reports
39. Sounds great, but: What do actual users say about it? Photo by Flipsnack on Unsplash
40. B D i r R t E k e “Wow, that was fast!?” c P o l
41. “Great, D i r R t E k e now I don’t have to talk c P o l B to people anymore!”
42. “First time documenting D i r R t E k e architecture – and c P o l B I really enjoyed it!”
43. “I never understood technical D i r R t E k e stuff, but this canvas? c P o l B It helps A LOT!”
44. Surely SOMETHING didn’t work out? Photo by Hans Eiskonen on Unsplash
45. People confused „Decisions“ and „Technologies“ k c o l B i r t e P E D R fake sample
46. Too verbose, aka: „People can’t be brief.“ k c o l B i r t e P fake sample
47. Things that didn’t work out Infrastructure Photo by Mika Baumeister on Unsplash
48. Things that didn’t work out Infrastructure Photo by Mika Baumeister on Unsplash People Photo by mauro mora on Unsplash
49. Things that didn’t work out Infrastructure Photo by Mika Baumeister on Unsplash People https://atlassian.design/foundations/logos Photo by mauro mora on Unsplash
50. draw.io, diagrams.net Tooling (1)
51. pptx Tooling (2)
52. Miro Tooling (3)
53. Tooling XL Miro, very nice
55. Acht Inklusive neuem Ka pitel: AI Opportu nity Canvas • verschiedene Canvas-Ansätze • von neun Expert:innen erklärt
56. Benjamin Wolf benjamin.wolf@innoq.com LinkedIn: benjaminwolf1985 Mastodon: @ben@innoq.social www.innoq.com
57. Benjamin Wolf benjamin.wolf@innoq.com LinkedIn: benjaminwolf1985 Mastodon: @ben@innoq.social www.innoq.com
58. D i “But… what about r R t E k e c P o l microservices?” B
59. Documenting microservices becomes a breeze. k c o l B i r t e P E D R
60. k c o l B i r t e P E D R