How gemeente-delft/gemeentelijk-gegevensmodel works
Stap 1: Projecttype en doel
• Dit project is géén traditionele full-stackapplicatie, maar een open-source datamodel-generator en documentatie-framework.
• Het primaire doel is het Gemeentelijk Gegevensmodel (GGM) als logisch UML-model beschikbaar te stellen, te vertalen naar fysieke databasetabellen (DDL) en te voorzien van uitgebreide documentatie.
Stap 2: Analyse van de bestandsstructuur
• Topniveau:
• README.md, LICENSE, PDF’s en UML-XMI-bestanden (bron-modellen)
• Versiemappen (v1.0.3 t/m v2.3.0) met EA, XMI en templatedefinities
• docs/ voor MkDocs-gebaseerde website en modeldefinities per domein
• tools/ voor codegeneratie, Docker-scripts en Jupyter notebooks
• mkdocs.yml voor documentatieconfiguratie
• Patroon: een duidelijke scheiding tussen
1. Modelleringartefacten (UML, XMI, EA, templates)
2. Documentatie (markdown + MkDocs)
3. Tooling (scripts, notebooks, Docker)
Stap 3: Belangrijke inzichten uit de README
• Het GGM is een logisch UML-model met lagen en domeinen
• Er is een “Code Template Framework” (Enterprise Architect) om DDL te genereren
• Ondersteuning voor externe tools: Enterprise Architect, Bizzdesign, BlueDolphin
• Tooling voor import/export: Jupyter notebooks en shell-scripts
Stap 4: Componenten en interacties voor het systeemschema
Componentenidentificatie
• UML-Model Repository
• Versie-mappen met .eap/.qea/.xmi
• Codegeneratie-templates (XML)
• Codegenerator Service
• Enterprise Architect met Code Template Framework
• Input: XMI/EAP_models + templates
• Output: DDL (Oracle, MySQL), CSV exports
• Documentatie-Website
• Markdown-bestanden onder docs/
• MkDocs (mkdocs.yml) genereert statische site
• Tooling Container
• Dockerfile & docker-compose in tools/
• Shell scripts (deploy.sh, process_excel.sh, translate.sh)
• Jupyter Notebooks voor data-manipulatie (tools/notebooks/)
• Version Control & Release Artifacts
• GitHub repo
• Versiemappen (v1.x, v2.x) met gegenereerde artefacten
Relaties en dataflow
• Developer checkt UML-model in Git →
• Codegenerator Service leest model + templates → genereert DDL & CSV → commit/output in tools/output of release-mappen
• MkDocs leest docs/ → bouwt en publiceert website
• Tooling Container biedt omgeving voor notebooks → verwerkt Excel/CSV → werkt GGM data bij of converteert
Architectuurpatronen en ontwerpprincipes
• Separation of Concerns: modellering, documentatie en tooling strikt gescheiden
• Layered Architecture in het UML-model zelf: horizontale vs. verticale domeinen
• Template-gedreven generatie (Code Template Framework)
• Containerisatie voor reproduceerbaarheid (Docker, Compose)
Belangrijke technologieën en libraries
• UML/XMI (Enterprise Architect, ArchiMate)
• Code Template Framework (EA)
• MkDocs (Python, Markdown)
• Jupyter Notebooks (Python)
• Docker, docker-compose, shell-scripts
• Focus op kernfunctionaliteit: GGM-modellering + codegeneratie
• Extensiepunten: nieuwe templates, extra notebooks, ondersteuning voor andere DB’s
• Laat integratie met externe tools (EA, Bizzdesign, BlueDolphin) zien
• Componentenblocks met duidelijke labels (Model Repository, Codegenerator, Documentation Site, Tooling Container, Externe Tools)
• Pijlen voor dataflow (XMI → generator → DDL, docs/ → MkDocs → Site, Excel → notebooks → CSV)
• Blauwe blokken = data/artifact stores
• Groene blokken = verwerkingscomponenten (generator, MkDocs, notebooks)
• Oranje blokken = externe tools/services
Voorbeeldindeling componentdiagram:
[Model Repository]
| (XMI/EAP + templates)
v
[Codegenerator Service: EA + Code Template Framework] ──> [DDL / CSV outputs]
[docs/] ──> [MkDocs] ──> [Website]
[tools/notebooks] ──> [Jupyter Engine] ──> [CSV/JSON exports]
[tools/Docker] ondersteunt alle toolingcomponenten in container omgeving
[Externe Tools: EA viewer, Bizzdesign, BlueDolphin] lezen artefacten direct uit versie-mappen
Let erop dat je in de legenda en titels de gebruikte technologieën benoemt en eventuele versie-mappen opneemt als artifact nodes.
Met deze bouwstenen kun je een volledig en gedetailleerd systeemontwerpdiagram tekenen dat exact de structuur en dataflows van het GGM-project weerspiegelt.