diff --git a/Content/Bijlagen/Terminologie.md b/Content/Bijlagen/Terminologie.md index 4338f589..2b6ad158 100644 --- a/Content/Bijlagen/Terminologie.md +++ b/Content/Bijlagen/Terminologie.md @@ -2,9 +2,10 @@ De onderstaande tabel bevat afkortingen en termen die voorkomen in de $KWALITEITSAANPAK$ en bijbehorende templates. -| Term/afkorting | Toelichting | -|:---------------|:------------| -| **actor** | een persoon die, of een extern informatiesysteem dat, een handeling verricht op het **informatiesysteem** | +| Term/afkorting | Toelichting | +|:---------------|:----------------------------------------------------------------------------------------------------------| +| **actor** | een persoon die, of een extern informatiesysteem dat, een handeling verricht op het **informatiesysteem** | +| **architectuur** | een beschrijving van de structuur van een systeem, inclusief onderdelen, relaties tussen die onderdelen en eigenschappen van die onderdelen en relaties. | **API** | application programming interface | | **ART** | automatische **regressietest** | | **auditing** | Vastlegging van de door een actor verrichtte handelingen. | @@ -22,6 +23,7 @@ De onderstaande tabel bevat afkortingen en termen die voorkomen in de $KWALITEIT | **GFO** | globaal functioneel ontwerp | | **IB-plan** | informatiebeveiligingsplan | | **informatiesysteem** | een samenhangend geheel van gegevensverzamelingen en de daarbij behorende personen, procedures, processen en **programmatuur** alsmede de voor het informatiesysteem getroffen voorzieningen voor opslag, verwerking en communicatie [VIR 2007, NORA] +| **infrastructuurarchitectuur** | een **architectuur** die vooral de hardwareonderdelen en -relaties (housing, hardware, virtuals, standaard software en middleware) van een systeem beschrijft | | **IPO** | intern projectoverleg | | **ISD** | ICTU Software Diensten, afdeling van ICTU die **softwareontwikkelprojecten** ondersteunt met ontwikkel- en testomgevingen, tools en diensten | | **ISE** | ICTU Software Expertise, afdeling van ICTU die **softwareontwikkelprojecten** ondersteunt met expertise op het gebied van **softwareontwikkeling** en die de $KWALITEITSAANPAK$ onderhoudt | @@ -58,6 +60,7 @@ De onderstaande tabel bevat afkortingen en termen die voorkomen in de $KWALITEIT | **Scrum** | Scrum is een lichtgewicht raamwerk dat mensen, teams en organisaties helpt om waarde te creёren door middel van adaptieve oplossingen voor complexe problemen [Scrumgids] | | **Scrummaster** | De Scrummaster is verantwoordelijk voor het opzetten van **Scrum**, zoals staat beschreven in de Scrumgids [Scrumgids] | | **Scrumteam** | Een Scrumteam bestaat uit één **Scrummaster**, één **product owner** en **ontwikkelaars** (*developers* in de Scrumgids) [Scrumgids]. | +| **softwarearchitectuur** | een **architectuur** die vooral de softwareonderdelen en -relaties (processen, modules, interfaces, datamodel) van een systeem beschrijft. | **software delivery manager** | organiseert het ontwikkelen en opleveren van **software** conform de vastgestelde eisen en de Kwaliteitsaanpak en rapporteert aan de **projectleider** | **software** | software is de verzameling instructies die bepalen wat een computer uitvoert en is uiteindelijk wat de gebruiker ziet, ervaart en waarmee hij interacteert. | | **softwareontwikkeling** | een activiteit die nieuwe **software** maakt en/of bestaande software aanpast | diff --git a/Content/Templates/HLD/Doelgroep.md b/Content/Templates/HLD/Doelgroep.md deleted file mode 100644 index 82dfe701..00000000 --- a/Content/Templates/HLD/Doelgroep.md +++ /dev/null @@ -1,3 +0,0 @@ -## Doelgroep - -De doelgroep van het opgestelde high-level design (HLD) zijn de partijen betrokken bij of verantwoordelijk voor de daadwerkelijke realisatie van de infrastructuur en de partijen betrokken bij de softwareontwikkeling, aangezien de software op die infrastructuur zal moeten draaien. diff --git a/Content/Templates/IA/Doelgroep.md b/Content/Templates/IA/Doelgroep.md new file mode 100644 index 00000000..a5d334f9 --- /dev/null +++ b/Content/Templates/IA/Doelgroep.md @@ -0,0 +1,3 @@ +## Doelgroep + +De doelgroep van het opgestelde infrastructuurarchitectuur (IA) zijn de partijen betrokken bij of verantwoordelijk voor de daadwerkelijke realisatie van de infrastructuur en de partijen betrokken bij de softwareontwikkeling, aangezien de software op die infrastructuur zal moeten draaien. diff --git a/Content/Templates/HLD/Kaders.md b/Content/Templates/IA/Kaders.md similarity index 100% rename from Content/Templates/HLD/Kaders.md rename to Content/Templates/IA/Kaders.md diff --git a/Content/Templates/HLD/Leeswijzer.md b/Content/Templates/IA/Leeswijzer.md similarity index 100% rename from Content/Templates/HLD/Leeswijzer.md rename to Content/Templates/IA/Leeswijzer.md diff --git a/Content/Templates/HLD/Managementsamenvatting.md b/Content/Templates/IA/Managementsamenvatting.md similarity index 100% rename from Content/Templates/HLD/Managementsamenvatting.md rename to Content/Templates/IA/Managementsamenvatting.md diff --git a/Content/Templates/HLD/Over-dit-document.md b/Content/Templates/IA/Over-dit-document.md similarity index 71% rename from Content/Templates/HLD/Over-dit-document.md rename to Content/Templates/IA/Over-dit-document.md index 1e58e52e..a420b552 100644 --- a/Content/Templates/HLD/Over-dit-document.md +++ b/Content/Templates/IA/Over-dit-document.md @@ -1,6 +1,6 @@ ## Over dit document -Het high-level design (HLD) heeft als doel om een globaal overzicht te geven van de technische infrastructuur van {systeem}. Hierbij is er vanuit gegaan dat de oplossing ten minste {aantal} jaar conform specificaties kan functioneren. In de praktijk is een kortere of langere periode mogelijk. +De infrastructuurarchitectuur (IA) heeft als doel om een globaal overzicht te geven van de technische infrastructuur van {systeem}. Hierbij is er vanuit gegaan dat de oplossing ten minste {aantal} jaar conform specificaties kan functioneren. In de praktijk is een kortere of langere periode mogelijk. Onder infrastructuur wordt verstaan het samenstel van alle generieke off-the-shelf ICT-componenten die nodig zijn om de applicatie te kunnen installeren, operationeel te maken en houden. De infrastructuur eindigt daar waar specifieke elementen (code) en applicatiespecifieke configuraties ontstaan. Concreet omvat de infrastructuur: @@ -10,3 +10,5 @@ Onder infrastructuur wordt verstaan het samenstel van alle generieke off-the-she * Standaardsoftware/middleware (operating system, webserver, applicatieserver, databaseserver, messaging- en ontwikkelplatform, etc.). Dit document beschrijft de lagen van de hardware en virtuals op het niveau van globale settings, netwerkarchitectuur en guidelines. Er zal dus niet op technisch detailniveau worden ingegaan op instellingen van routers, firewalls, virtualisatie en (virtuele) servers. + +Waar in dit document gesproken wordt van infrastructuurarchitectuur (IA) mag ook high level design (HLD) gelezen worden. diff --git a/Content/Templates/HLD/Relatie-documenten.md b/Content/Templates/IA/Relatie-documenten.md similarity index 100% rename from Content/Templates/HLD/Relatie-documenten.md rename to Content/Templates/IA/Relatie-documenten.md diff --git a/Content/Templates/HLD/Specifieke-Bijlagen.md b/Content/Templates/IA/Specifieke-Bijlagen.md similarity index 100% rename from Content/Templates/HLD/Specifieke-Bijlagen.md rename to Content/Templates/IA/Specifieke-Bijlagen.md diff --git a/Content/Templates/HLD/Template-Inhoud.md b/Content/Templates/IA/Template-Inhoud.md similarity index 100% rename from Content/Templates/HLD/Template-Inhoud.md rename to Content/Templates/IA/Template-Inhoud.md diff --git a/Content/Templates/HLD/Uitgangspunten.md b/Content/Templates/IA/Uitgangspunten.md similarity index 100% rename from Content/Templates/HLD/Uitgangspunten.md rename to Content/Templates/IA/Uitgangspunten.md diff --git a/Content/Templates/PvA-Realisatiefase/Relatie-documenten.md b/Content/Templates/PvA-Realisatiefase/Relatie-documenten.md index 3116231a..a7a8bd40 100644 --- a/Content/Templates/PvA-Realisatiefase/Relatie-documenten.md +++ b/Content/Templates/PvA-Realisatiefase/Relatie-documenten.md @@ -7,7 +7,6 @@ De realisatiefase is een vervolg op de voorfase {voorfaseproject}. De documenten * Privacy impact assessment (PIA), versie {versie}, * Softwarearchitectuurdocument (SAD), versie {versie}, * Infrastructuurarchitectuur (IA), versie {versie}, -* High level design (HLD), versie {versie}, * Mastertestplan, versie {versie}, * Testplan softwarerealisatie, versie {versie}, * Informatiebeveiligingsplan (IB-plan), versie {versie}, diff --git a/Content/Templates/PvA-Realisatiefase/Template-Inhoud.md b/Content/Templates/PvA-Realisatiefase/Template-Inhoud.md index 0a1c68bd..adab2df6 100644 --- a/Content/Templates/PvA-Realisatiefase/Template-Inhoud.md +++ b/Content/Templates/PvA-Realisatiefase/Template-Inhoud.md @@ -118,7 +118,7 @@ Onderstaand is de verwachte inzet van {opdrachtgever/partijen} voor de uitvoerin | Product owner | {aantal} dagen | Prioritering user stories, sprintplanning, demo, onderhouden backlog | | Business analist | {aantal} dagen | Epics opstellen voor de product backlog, eventueel uitgewerkt in user stories | | Architect | {aantal} dagen | Bewaken en onderhouden van de softwarearchitectuur | -| Infrastructuurarchitect | {aantal} dagen | Bewaken en onderhouden infrastructuurarchitectuur, opstellen high level design (HLD) | +| Infrastructuurarchitect | {aantal} dagen | Bewaken en onderhouden infrastructuurarchitectuur, opstellen infrastructuurarchitectuur (IA) | | Testmanager | {aantal} dagen | Testen van nieuwe softwarereleases voordat deze voor gebruik worden vrijgegeven | | Expert informatiebeveiliging | {aantal} dagen | Bewaken en onderhouden BIA, opstellen TVA en IB-plan | | Privacy-expert | {aantal} dagen | Bewaken en onderhouden PIA | diff --git a/Content/Templates/PvA-Voorfase/Template-Inhoud.md b/Content/Templates/PvA-Voorfase/Template-Inhoud.md index 15d9b662..587575da 100644 --- a/Content/Templates/PvA-Voorfase/Template-Inhoud.md +++ b/Content/Templates/PvA-Voorfase/Template-Inhoud.md @@ -17,7 +17,6 @@ In de voorfase worden de volgende producten gerealiseerd op basis van {bronnen, | Interactie-ontwerp (UX) | {verantwoordelijke} | ICTU | {reviewers} | | Softwarearchitectuurdocument (SAD) | {verantwoordelijke} | ICTU | {reviewers} | | Infrastructuurarchitectuur (IA) | {verantwoordelijke} | {penvoerder} | ICTU, {reviewers} | -| High level design (HLD) | {verantwoordelijke} | {penvoerder} | ICTU, {reviewers} | | Product risico analyse (PRA) | {verantwoordelijke} | {penvoerder} | ICTU, {reviewers} | | Mastertestplan (op basis van PRA) | {verantwoordelijke} | {penvoerder} | ICTU, {reviewers} | | Testplan softwarerealisatie | {verantwoordelijke} | ICTU | {reviewers} | @@ -109,7 +108,7 @@ Onderstaand is de verwachte inzet van {opdrachtgever/partijen} voor de uitvoerin |:----------------------------------------------|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------| | Expert informatiebeveiliging | {aantal} dagen | Uitvoeren TVA, opstellen BIA en IB-plan, reviewen {documenten} | | Privacy-expert | {aantal} dagen | Opstellen PIA, reviewen {documenten} | -| Infrastructuurarchitect | {aantal} dagen | Opstellen infrastructuurarchitectuur en high level design (HLD), reviewen SAD, NFE en IB-plan | +| Infrastructuurarchitect | {aantal} dagen | Opstellen infrastructuurarchitectuur, reviewen SAD, NFE en IB-plan | | Architect | {aantal} dagen | Richting geven aan architectuur, opstellen PSA, reviewen SAD, NFE en infrastructuurarchitectuur | | Testmanager | {aantal} dagen | Uitvoeren PRA, opstellen mastertestplan, reviewen kwaliteitsplan, testplan softwarerealisatie | | Diverse inhoudelijk deskundigen | {aantal} dagen | Eventuele betrokkenheid van (eind)gebruikers en belanghebbenden | diff --git a/Content/Wijzigingsgeschiedenis.md b/Content/Wijzigingsgeschiedenis.md index 314d9a78..5b29e04c 100644 --- a/Content/Wijzigingsgeschiedenis.md +++ b/Content/Wijzigingsgeschiedenis.md @@ -27,7 +27,8 @@ #### Alle documenten * De term "DevOps-werkwijze" vervangen door "operationeel beheer" of door "operationeel en/of applicatiebeheer" op de plekken waar het gaat over de dienstverlening en niet zozeer over de aanpak. -* 'Beheerorganisatie' en 'beheerpartij' werden door elkaar gebruikt. Alle voorkomens van beheerpartij vervangen door beheerorganisatie. +* De term "high level design" (HLD) vervangen door "infrastructuurarchitectuur" (IA) of waar beide termen werden gebruikt HLD verwijderd. Het HLD-template hernoemd naar IA-template. +* "Beheerorganisatie" en "beheerpartij" werden door elkaar gebruikt. Alle voorkomens van beheerpartij vervangen door beheerorganisatie. ### Versie 3.0.1, 4 april 2023 diff --git a/DocumentDefinitions/high-level-design.json b/DocumentDefinitions/infrastructuurarchitectuur.json similarity index 78% rename from DocumentDefinitions/high-level-design.json rename to DocumentDefinitions/infrastructuurarchitectuur.json index b794e02f..e1993e84 100644 --- a/DocumentDefinitions/high-level-design.json +++ b/DocumentDefinitions/infrastructuurarchitectuur.json @@ -1,15 +1,15 @@ { "InputFile": "DocumentDefinitions/Templates/document-template.md", - "BuildPath": "build/Templates/HLD/", + "BuildPath": "build/Templates/IA/", "Title": "High-Level Design", "Subtitle": "{Productnaam, versie}", "DocumentType": "Template", - "DocumentFolder": "HLD", + "DocumentFolder": "IA", "FrontPage": "Neutral", "IncludeTableOfContents": true, "OutputFormats": { "docx": { - "OutputFile": "Neutraal-Template-High-Level-Design.docx", + "OutputFile": "Neutraal-Template-Infrastructuurarchitectuur.docx", "OutputPaths": [ "docs/wip" ], diff --git a/docs/wip/Neutraal-Template-Infrastructuurarchitectuur.docx b/docs/wip/Neutraal-Template-Infrastructuurarchitectuur.docx new file mode 100644 index 00000000..dff76c63 Binary files /dev/null and b/docs/wip/Neutraal-Template-Infrastructuurarchitectuur.docx differ