Voorbereiding

We werken in Soex met Spikes en Taken. Neem de genoemde pagina's door. De eerste tweek weken van SOEX maken wij de spikes voor je aan in je github issues. De derde week moet je deze zelf aan gaan maken.

In TEEX heb je het volgende filmpje over het C4 model al eerder gezien. Neem het filpje nog eens door en maak notities:

• noteer begrippen die je niet kent en uitspraken of plaatjes die je niet begrijpt
• benoem daarbij zo specifiek mogelijk wat je niet kent of niet begrijpt
• neem de aantekeningen mee naar de les!

Beantwoord na het bekijken van het filmpje onderstaande quizvragen om je kennis te testen.

1. C4 model

2. C4 Quiz

1. Welke van de onderstaande modellen hoort NIET bij C4?

(System) ContextContainerCommunicationComponent

2. Op welke manieren kun je C4 visualiseren?

Met UMLAlleen met specifieke C4 toolingDoor middel van flowchartsMet BPMN

3. Welke analogie gebruikt Simon Brown om (C4-)diagrammen uit te leggen?

Architectuur zoals bij gebouwen als het Sydney Opera HouseEen boek met hoofdstukken en paragrafenEen film met scenes en shotsLandkaarten zoals Google Maps

4. Wat is het idee van C4?

Om Software Architectuur te documenteren met de 4 diagrammen in deze volgordeOm Software Architectuur te documenteren met (4) verschillende detailniveausOm gebruikersdocumentatie te schrijven volgens de Communicate, Characterize, Code, Compile loopOm gebruikersdocumentatie te schrijven met de 4 diagrammen in deze volgorde

5. Wat is het idee van een C4 Context diagram?

Tonen van je applicatie en diens omgeving in termen van gebruikers en externe systemenOm de data context te geven van je applicatie in termen van datastructuren en functies/activiteitenVisualiseren van de interne architectuur van een systeem met alle componentenWeergeven hoe verschillende modules (of microservices) met elkaar communiceren

6. Wat is het idee van een C4 Container diagram?

Om de — apart op te leveren — componenten van je applicatie te tonen en hun communicatie onderling en met de gebruikers en evt. externe systemenOm de data context te geven van je applicatie in termen van datastructuren en functies/activiteitenVisualiseren van de interne component architectuur van je systeem, zonder gebruikers en externe systemenOm de Docker containers te tonen waaruit je applicatie bestaat (bv. een applicatie container en database container)

7. Wat is het idee van een C4 Component diagram?

Om in te zoomen op de API onderdelen van je applicatie en de code details ervan, zoals inlog functies, gehashde wachtwoorden, etc.Om de Docker componenten waaruit je applicatie bestaat (bv. een applicatie component, database component, etc.)Om in te zoomen op een component en de 'lower level tech choices' hierbij, zoals gebruikte functies, OO overerving, etc.Om in te zoomen op een component en de 'lower level tech choices' hierbij, zoals framework/taal specifieke concepten zoals .jar files, namespaces, Spring Boot Controller, MongoDB schema definities, etc.

8. Wat is het idee van een C4 level 4 diagram?

Het diepste detailniveau dat of de code beschrijft in bijv. class diagrams. Simon Brown raadt aan dit (code) niveau niet per se te documenteren, soms is een link naar de code al voldoende.Het tonen van het totaal van de 1e 3 levels.Een gedetailleerd overzicht van alle services en hun interacties.Een abstract overzicht van de technische infrastructuur.

9. Wat komt er in de blokhaken van een box in een C4 diagram?

De naam van de ontwikkelaar en het team dat verantwoordelijk is voor het componentEen korte functionele beschrijving, bijvoorbeeld 'Authenticatie Service' of 'Orderverwerking'De technische naam of implementatiedetail, zoals een Spring Bean, .jar-bestand of een namespaceDe exacte versie en configuratieparameters van het component, zoals 'Spring Boot 2.7 met caching ingeschakeld'

10. Wat raadt Simon Brown aan?

Zet niet te veel tekst in de boxes, dat hoort niet in een architectuur diagramDenk na of je lijnen pijlpunten geeft en of er een pijl 0, 1 of 2 kanten op wijstZet voldoende tekst bij een box om de naam uit te leggen en zorg dat pijlrichting overeenkomt met de beschrijvende tekst erbijHou pijlbeschrijving kort zoals 'uses', en toon bidirectionaliteit via pijlen zoals http request/response, of events via een message bus als Kafka of RabbitMQ

11. En wat raadt Simon Brown nog meer aan?

Zet altijd een legenda bij een diagramMaak externe systemen grijs, interne onderdelen blauw of andere kleurGebruik iconen en kleuren om zaken aan te geven (maar diagram moet ook zonder kleur begrijpbaar zijn; accessibility)Al bovenstaande