Nieuw architectuurplaatje

Geonovum · Feb 7, 2025 · 2490620 · 2490620
1 parent fbe48a0
commit 2490620
Show file tree

Hide file tree

Showing 5 changed files with 134 additions and 85 deletions.
diff --git a/docs/EA.md b/docs/EA.md
@@ -1,24 +1,16 @@
 # Enterprise Architect
 
-Instructie voor het gebruik van Enterprise Architect binnen Geonovum:
+Binnen Geonovum wordt UML vaak gebruikt als modelleertaal. Enterprise Architect
+is de UML editor die we gebruiken.
 
-- Installatie van de software.
-- Gebruik van de MIM Toolbox.
 
 ## Installatie
 
-- Op de website is een proefversie van
-  [Enterprise Architect](https://www.sparxsystems.eu/) te downloaden.
 - Neem voor een licentie contact op met de
   [beheerder](https://stichtinggeonovum.sharepoint.com/:b:/r/sites/FBICT/Gedeelde%20documenten/General/wat%20staat%20waar/Tooling_en_Beheerders.pdf?csf=1&web=1&e=aEcKjl)
 
-## De MIM toolbox
+Binnen UML maken we vaak gebruik van MIM. Hiervoor moet je de [MIM toolbox importeren](MIM-toolbox-importeren.md)
 
-Importeer de MIM toolbox:
-
-Zie: [MIM toolbox importeren](MIM-toolbox-importeren.md)
-
-Externe links:
 
 - [Handleiding gebruik MIM-toolbox](https://github.com/Geonovum/MIM-Werkomgeving/blob/master/UML%20profieltooling/werkversie1.1.1/README.md)
 - [Handleiding genereren MIM-profiel](https://github.com/Geonovum/MIM-Werkomgeving/tree/master/UML%20profieltooling#readme)

diff --git a/docs/GML.md b/docs/GML.md
@@ -1,12 +1,13 @@
 # GML en XSD
 
-Een algemene handleiding voor het opslaag van Geometrie in GML bestanden is te vinden in: [Geometrie in model en GML](https://geonovum.github.io/gimeg/)
+Een algemene handleiding voor het opslaan van Geometrie in GML bestanden is te
+vinden in: [Geometrie in model en GML](https://geonovum.github.io/gimeg/)
 
 ## XSD en Namespaces
 
-Bij een XML applicatie schema (dus ook voor GML schema's) wordt vaak een namespace gebruikt. Deze namespace hoort vaak bij een domein en het is de bedoel dat de combinatie van de namespace  en het element uniek is. Dit kan alleen als de namespace, die de vorm van een URI heeft uniek is. Door een URI te kiezen die bij jou onder beheer is weet je zeker dat de combinatie uniek is. In de volgende paragraaf zie je een lijste gebruikte namespaces. Hieronder wat richtlijnen.
+In een GML applicatieschema gebruiken we namespaces. Een namespace is de heeft de vorm van een URI en identificeert een domein. 
 
-- Voor de basis wordt: http://www.geostandaarden.nl gebruikt.  Het is nog even de vraag of we niet op https moeten overstappen. Dat doen we niet want niemand anders doet deze overstap.
+- Voor de basis wordt: http://www.geostandaarden.nl gebruikt.
 - Daarna volgt een identificatie van de standaard. 
 - Een versienummer volgens semver X.Y. Een Z-versie is niet nodig omdat alle Z-versies backwards compatible zijn en je dus nooit meer dan 1 versie gebruikt.
 
@@ -44,6 +45,4 @@ Een korte inventarisatie levert:
 | imkl2015 (wionbr) | 1.2       | http://www.geostandaarden.nl/imkl/2015/wionbr/1.2                        |
 | imkl2015 (wionbr) | 1.2.1     | http://www.geostandaarden.nl/imkl/2015/wionbr/1.2                        |
 | top10nl           | 1.1.1     | http://www.kadaster.nl/schemas/top10nl/v20120116                         |
-| top10nl            | 1.2.0     | http://register.geostandaarden.nl/gmlapplicatieschema/top10nl/1.2.0      |
-|                   |           |                                                                          |
-
+| top10nl           | 1.2.0     | http://register.geostandaarden.nl/gmlapplicatieschema/top10nl/1.2.0      |
diff --git a/docs/MIM-toolbox-genereren.md b/docs/MIM-toolbox-genereren.md
@@ -7,6 +7,7 @@
 | Subversion (SVN)     | 1.14.1 |
 
 ## Inhoud
+
  1. [Voorbereiding](#1-voorbereiding)
  1. [Profiel publiceren](#2-profiel-publiceren)
  1. [Genereer MDG Technologie](#3-genereer-mdg-technologie)
@@ -17,24 +18,27 @@
  1. [Regels](#8-regels)
 
 ## Beschrijving
+
 Deze handleiding beschrijft het proces voor het genereren van een customized toolbox voor modelleren met Enterprise Architect. Het gaat specifiek in op het maken van de _MIM-toolbox_. Maar ook voor het genereren customized toolboxen in het algemeen, biedt deze beschrijving een handig overzicht van de benodigde stappen. Een inhoudelijke beschrijving voor het maken van de benodigde profielen, vind je hier ([linkOpnemen](url)). De meest actuele versie van MIM kun je hier ([linkOpnemen](url)) raadplegen.
 
 <!-- ```diff
 NOG VERWERKEN
-+ In deze bexchrijving gaan we ervan uit dat de inhoud voor de toolbox al is aangemaakt
++ In deze beschrijving gaan we ervan uit dat de inhoud voor de toolbox al is aangemaakt
 + en dat deze in de juiste packages en dito structuur is opgenomen.
 + Beschrijving inhoudelijke informatie voor het maken van _profile packages_
 + (zelf schrijven en/of verwijzen naar _Sparx_/_profile helpers_)?
 ``` -->
 
 ## 1 Voorbereiding
+
 Controleer voordat je (MIM-)profielen gaat genereren eerst de volgende zaken:
 
  - Beschik je over de [benodigde bestanden](#benodigde-bestanden)?
  - Zijn de [benodigde profielen](#benodigde-profielen) aanwezig?
  - Is het [versienummer correct ingevuld](#versienummer-toolbox)?
 
 ### 1.1 Benodigde bestanden
+
 Controleer of je beschikt over alle benodigde bestanden:
 
  - **EA-bestand** met MIM profile packages voor het genereren van de profiles en mdg technology ([Create MDG Technology File](https://sparxsystems.com/enterprise_architect_user_guide/15.2/modeling/creatingmdgtechnologies.html)), hiertoe behoort ten minste één package per stereotype: `«profile»`, `«diagram profile»` en `«toolbox profile»` (zie voor meer informatie over ... ([linkOpnemenNaarWelkePackagesPubliceren](url)).
@@ -297,4 +301,4 @@ In ieder geval beschrijven:
 
  - `«profile»`, `«diagram profile»` en `«toolbox profile»` moeten dezelfde naam dragen
  - Bij het genereren van een profiel, moet _profile name_ gelijk zijn aan de naam die het profiel draagt
- - Binnen een package mogen elementen niet dezelfde naam hebben, maar MIM kent verschillende elementen met de naam '_Keuze_'. Om dit mogelijk te maken in de toolbox, zijn voor de keuze-elementen aparte aanvullende packages gemaakt. Vandaar dat er meerdere packages `«profile»` zijn. 
+ - Binnen een package mogen elementen niet dezelfde naam hebben, maar MIM kent verschillende elementen met de naam '_Keuze_'. Om dit mogelijk te maken in de toolbox, zijn voor de keuze-elementen aparte aanvullende packages gemaakt. Vandaar dat er meerdere packages `«profile»` zijn. 
diff --git a/docs/index.md b/docs/index.md
@@ -1,77 +1,113 @@
-# Welkom
-
-Welkom bij de beschrijving van de Geonovum Werkwijze. Deze helpfiles beschrijven
-welke tools we gebruiken voor het maken en beheren van de standaarden van
-Geonovum. Deze tools staan in onderstaand overzicht. Daaronder staat de
-publicatieomgeving van Geonovum beschreven.
-
-## Geonovum tooling
-
-- **UML Modelleertool:** Enterprise Architect
-    - [Overzicht](EA.md)
-    - [Primitieve datatypes](EA-toepassing-standaarddatatypen.md): Handleiding
-        en toelichting op het toepassen van standaarddatatypes in
-        modelleeromgeving Geonovum.
-- **GitHub**:
-    - [GitHub werkwijze](GitHub-Inleiding.md): algemene inleiding over GitHub.
-    - [GitHub handleiding](GitHub.md): Hoe maak je een account aan en hoe doe
-        je beheertaken.
-- **Imvertor**
-    - [Imvertor](Imvertor.md): Verwijzingen naar verschillende onderwerpen met
-        betrekking tot Imvertor.
-- **Markdown**
-    - [Markdown handleiding](Markdown.md): Handleiding werken met Markdown
-        voor ReSpec-documentatie.
-- **ReSpec**
-    - [Respec handleiding](ReSpec.md): Algemene handleiding.
-    - [Respec code toepassen](ReSpec-code-toepassen.md): Richtlijnen voor het
-        toepassen van code in documentatie.
-    - [Respec definitielijst maken](ReSpec-definitielijst-maken.md):
-        Handleiding voor het maken van een definitielijst in
-        ReSpec-documentatie.
-- **MIM**
-    - [Toolbox importeren](MIM-toolbox-importeren.md): Handleiding voor het
-        importeren van de MIM-toolbox in EA.
-    - [Toolbox genereren](MIM-toolbox-genereren.md): Handleiding voor het
-        maken van een EA-toolbox.
-    - [Toolbox genereren extensie](MIM-toolbox-genereren-extensie.md):
-        Handleiding voor het maken van een extensie op de MIM-toolbox.
-- **Subversion (SVN)**
-    - [Subversion installeren voor EA](SVN-importeren-bestaand-project.md):
-        Installatie SVN en informatiemodel in versiebeheer zetten.
-    - [Subversion importeren bestaand project](SVN-installeren-voor-EAP.md):
-        Packages importeren vanuit SVN in EA.
-- **GML**
-    - [GML](GML.md): Toelichting GML, XSD en Namespaces.
-- **Ontologie**
-    - [Ontologie](Handleiding-ontologie-maken-en-publiceren.md): Handleiding
-        voor het maken en publiceren van een ontologie.
-- **Word2XXX**
-    - [Word2werkversie](WordConversies.md)
+# Publicatie Infrastructuur van Geonovum
 
-Voor licenties of de interne beheerder van de tooling kun je terecht op
-[intranet](https://stichtinggeonovum.sharepoint.com/:b:/r/sites/FBICT/Gedeelde%20documenten/General/wat%20staat%20waar/Tooling_en_Beheerders.pdf?csf=1&web=1&e=aEcKjl)
+Dit is de publicatie infrstructuur van Geonovum. Onder het architectuurplaatje staan:
+
+- Een korte [beschrijving](#kort-overzicht).
+- Verwijzing naar [documentatie](#documentatie).
+- Verbeterpunten [verbeterpunten](#verbeterpunten).
+
+
+![Publicatie Infrastructuur Geonvoum](media/PublicatieInfrastructuurGeonovum.drawio.svg)
+
+## Kort Overzicht
+
+### [1] UML
+
+- UML klasse diagrammen maken we met Enterprise Architect.
+- Binnen UML gebruiken we MIM als metataal.
+- Ook gebruiken we NEN 3610 als raamwerk.
+
+### [2] Subversion
+
+- De UML diagram worden met subversion (svn) beheerd.
+- Deze server draait op `svn.geostandaarden.nl`
+
+### [3] Imvertor
+
+- Imvertor vertaalt het UML naar catalog, xsd etc.
+
+### [4] ReSpec document
+
+- Onze standaarden maken we in ReSpec.
+- Dit is een tool die uit een aantal bestanden (Markdown, HTML) een mooi document publiceert.
+- De bestanden beheren we in GitHub
+
+### [5] GitHub
+
+- Onze standaarden beheren en versioneren we in GitHub.
+
+### [6] docs.geostandaarden.nl
+
+- Onze standaarden publiceren we op docs.geostandaarden.nl
+- Dit doen we door het ftp de bestanden daarnaartoe te kopieren.
+
+### [7] tools.geostandaarden.nl
+
+- Op deze server staan css bestanden en hulpbestanden voor ReSpec
 
-### Documentatie elders
+## Documentatie
 
-De documentatie van de werkwijze is niet alleen hier vastgelegd. Links naar
-andere documenten:
+### [1] UML
 
-- [werkomgeving modelleren](werkomgeving-modelleren.md).
-- [werkwijze modelleren](werkwijze-modelleren.md).
-- [geonovum werkwijze modelleren](geonovum-werkwijze-modelleren.md)
+- [Overzicht](EA.md)
+- [Primitieve datatypes](EA-toepassing-standaarddatatypen.md): Handleiding
+    en toelichting op het toepassen van standaarddatatypes in
+    modelleeromgeving Geonovum.
 
-## Geonovum publicatieomgeving
+### [2] Subversion
 
-Verschillende onderdelen van standaarden worden op verschillende plaatsen
-gepubliceerd. De publicatieomgeving ziet er als volgt uit
+- [Subversion installeren voor EA](SVN-importeren-bestaand-project.md):
+    Installatie SVN en informatiemodel in versiebeheer zetten.
+- [Subversion importeren bestaand project](SVN-installeren-voor-EAP.md):
+    Packages importeren vanuit SVN in EA.
 
-![Architectuurplaatje](https://raw.githubusercontent.com/Geonovum/DrawIO/master/GeonovumInterneArchitectuur.drawio.png)
-### Documenten (docs.geostandaarden.nl)
+### [3] Imvertor
+
+- [Imvertor](Imvertor.md): Verwijzingen naar verschillende onderwerpen met
+    betrekking tot Imvertor.
+
+### [4] ReSpec
+- [Respec handleiding](ReSpec.md): Algemene handleiding.
+- [Respec code toepassen](ReSpec-code-toepassen.md): Richtlijnen voor het
+    toepassen van code in documentatie.
+- [Respec definitielijst maken](ReSpec-definitielijst-maken.md):
+    Handleiding voor het maken van een definitielijst in
+    ReSpec-documentatie.
+
+### [5] GitHub*
+- [GitHub werkwijze](GitHub-Inleiding.md): algemene inleiding over GitHub.
+- [GitHub handleiding](GitHub.md): Hoe maak je een account aan en hoe doe
+    je beheertaken.
+
+### [6] docs.geostandaarden.nl
+- Zie [pubDomainList.json](https://github.com/Geonovum/respec-utils/blob/master/src/autodeploy/config/pubDomainList.json)
+
+### Markdown
+ - [Markdown handleiding](Markdown.md): Handleiding werken met Markdown
+     voor ReSpec-documentatie.
+
+### MIM
+- [Toolbox importeren](MIM-toolbox-importeren.md): Handleiding voor het
+    importeren van de MIM-toolbox in EA.
+- [Toolbox genereren](MIM-toolbox-genereren.md): Handleiding voor het
+    maken van een EA-toolbox.
+- [Toolbox genereren extensie](MIM-toolbox-genereren-extensie.md):
+    Handleiding voor het maken van een extensie op de MIM-toolbox.
+
+### GML
+
+- [GML](GML.md): Toelichting GML, XSD en Namespaces.
+### Ontologie
+
+- [Ontologie](Handleiding-ontologie-maken-en-publiceren.md): Handleiding
+    voor het maken en publiceren van een ontologie.
+### Word2XXX
+
+- [Word2werkversie](WordConversies.md)
+
+Voor licenties of de interne beheerder van de tooling kun je terecht op
+[intranet](https://stichtinggeonovum.sharepoint.com/:b:/r/sites/FBICT/Gedeelde%20documenten/General/wat%20staat%20waar/Tooling_en_Beheerders.pdf?csf=1&web=1&e=aEcKjl)
 
-Standaarden en technische documentatie. Voor een nette lijst van pubdomains op
-docs.geostandaarden.nl moet de de volgende lijst up-to-date zijn:
-[pubDomainList.json](https://github.com/Geonovum/respec-utils/blob/master/src/autodeploy/config/pubDomainList.json)
 
 ### Het Technisch Register (register.geostandaarden.nl)
 
@@ -88,6 +124,20 @@ Dit is uitgelegd in de [handleiding ontologie maken](Handleiding-ontologie-maken
 
 ### Conceptenbibliotheek (definities.geostandaarden.nl)
 
+
+## Verbeterpunten
+
+### [1] UML
+
+- Er is een alternatieve tool voor UML: 
+
+### [3] Imvertor
+
+- De beheerders van Imvertor willen binnenkort met pensioen.
+- Imvertor is niet echt modulair
+
+### [6] Imvertor
+
 ## MkDocs voor deze handleiding
 
 De handleiding wordt beheerd in [MkDocs](https://www.mkdocs.org/). Dit is een

diff --git a/docs/media/PublicatieInfrastructuurGeonovum.drawio.svg b/docs/media/PublicatieInfrastructuurGeonovum.drawio.svg