From 239fe47a57306ebbd89547fa806c44d9fd99183c Mon Sep 17 00:00:00 2001 From: Frank Niessink Date: Tue, 20 Feb 2024 18:16:37 +0100 Subject: [PATCH] Verbeteringen KP-template en andere templates. Closes #840. --- Content/Templates/Colofon.md | 42 +++++++++---------- .../Templates/Compacte-Voorfase/Doelgroep.md | 2 +- .../Doelgroep.md | 2 +- .../Template-Inhoud.md | 2 +- .../Uitgangspunten.md | 2 +- Content/Templates/GFO/Doelgroep.md | 2 +- Content/Templates/GFO/Kaders.md | 2 +- Content/Templates/GFO/Over-dit-document.md | 4 +- Content/Templates/GFO/Template-Inhoud.md | 8 ++-- Content/Templates/GFO/Uitgangspunten.md | 2 +- Content/Templates/IA/Over-dit-document.md | 2 +- Content/Templates/IA/Uitgangspunten.md | 2 +- .../Relatie-documenten.md | 6 +-- .../Kwaliteitsplan/Managementsamenvatting.md | 4 +- .../Kwaliteitsplan/Over-dit-document.md | 2 +- .../Kwaliteitsplan/Relatie-documenten.md | 4 +- .../Kwaliteitsplan/Template-Inhoud.md | 18 ++++---- .../Templates/NFE/Managementsamenvatting.md | 8 ++-- Content/Templates/NFE/Over-dit-document.md | 2 +- Content/Templates/NFE/Template-Inhoud.md | 2 +- .../Templates/PvA-Realisatiefase/Doelgroep.md | 2 +- .../PvA-Realisatiefase/Over-dit-document.md | 6 +-- .../PvA-Realisatiefase/Relatie-documenten.md | 2 +- .../PvA-Realisatiefase/Template-Inhoud.md | 24 +++++------ .../PvA-Realisatiefase/Uitgangspunten.md | 12 +++--- Content/Templates/PvA-Voorfase/Doelgroep.md | 2 +- .../PvA-Voorfase/Over-dit-document.md | 2 +- .../Templates/PvA-Voorfase/Template-Inhoud.md | 22 +++++----- .../Templates/PvA-Voorfase/Uitgangspunten.md | 6 +-- Content/Templates/SAD/Doelgroep.md | 2 +- Content/Templates/SAD/Over-dit-document.md | 2 +- Content/Templates/SAD/Template-Inhoud.md | 10 ++--- Content/Wijzigingsgeschiedenis.md | 5 +++ 33 files changed, 110 insertions(+), 105 deletions(-) diff --git a/Content/Templates/Colofon.md b/Content/Templates/Colofon.md index f3f0f2e7..b3d672cd 100644 --- a/Content/Templates/Colofon.md +++ b/Content/Templates/Colofon.md @@ -12,36 +12,36 @@ Rubricering conform [VIRBI 2013, art. 4](https://wetten.overheid.nl/BWBR0033507/ ###### Revisiehistorie -| Versie | Auteur | Datum | Status | Opmerkingen | -|:---------|:-------|:--------|:---------------------|:--------------| -| {versie} | {naam} | {datum} | {concept/definitief} | {opmerkingen} | +| Versie | Auteur | Datum | Status | Opmerkingen | +|:---------|:--------------|:--------|:---------------------|:--------------| +| {versie} | {naam auteur} | {datum} | {concept/definitief} | {opmerkingen} | ###### Reviewers -| Functie/rol | Naam | Datum | Versie | -|:------------------------------------------------|:-------|:--------|:--------:| -| Kwaliteitsmanager {opdrachtgevende organisatie} | {naam} | {datum} | {versie} | -| Kwaliteitsmanager {beheerorganisatie} | {naam} | {datum} | {versie} | -| Kwaliteitsmanager ICTU | {naam} | {datum} | {versie} | +| Functie/rol | Naam | Datum | Versie | +|:------------------------------------------------|:-----------------------------------------------------|:--------|:--------:| +| Kwaliteitsmanager {opdrachtgevende organisatie} | {naam kwaliteitsmanager opdrachtgevende organisatie} | {datum} | {versie} | +| Kwaliteitsmanager {beheerorganisatie} | {naam kwaliteitsmanager beheerorganisatie} | {datum} | {versie} | +| Kwaliteitsmanager ICTU | {naam kwaliteitsmanager ICTU} | {datum} | {versie} | ###### Vereiste goedkeuringen -| Functie/rol | Naam | Datum | Versie | -|:--------------------------------------------|:-------|:--------|:--------:| -| Projectleider {opdrachtgevende organisatie} | {naam} | {datum} | {versie} | -| Projectleider {beheerorganisatie} | {naam} | {datum} | {versie} | -| Projectleider ICTU | {naam} | {datum} | {versie} | -| Product owner | {naam} | {datum} | {versie} | +| Functie/rol | Naam | Datum | Versie | +|:--------------------------------------------|:-------------------------------------------------|:--------|:--------:| +| Projectleider {opdrachtgevende organisatie} | {naam projectleider opdrachtgevende organisatie} | {datum} | {versie} | +| Projectleider {beheerorganisatie} | {naam projectleider beheerorganisatie} | {datum} | {versie} | +| Projectleider ICTU | {naam projectleider ICTU} | {datum} | {versie} | +| Product owner | {naam product owner} | {datum} | {versie} | ###### Verzendlijst huidige versie -| Naam | Organisatie | Functie/rol | -|:-------|:------------------------------|:--------------------------| -| {naam} | {opdrachtgevende organisatie} | Projectleider | -| {naam} | {opdrachtgevende organisatie} | Product owner | -| {naam} | {beheerorganisatie} | Projectleider | -| {naam} | ICTU | Projectleider | -| {naam} | ICTU | Software delivery manager | +| Naam | Organisatie | Functie/rol | +|:-------------------------------------------------|:------------------------------|:--------------------------| +| {naam projectleider opdrachtgevende organisatie} | {opdrachtgevende organisatie} | Projectleider | +| {naam product owner} | {opdrachtgevende organisatie} | Product owner | +| {naam projectleider beheerorganisatie} | {beheerorganisatie} | Projectleider | +| {naam projectleider ICTU} | ICTU | Projectleider | +| {naam software delivery manager} | ICTU | Software delivery manager | ###### Template versie diff --git a/Content/Templates/Compacte-Voorfase/Doelgroep.md b/Content/Templates/Compacte-Voorfase/Doelgroep.md index f963531f..c9810bd4 100644 --- a/Content/Templates/Compacte-Voorfase/Doelgroep.md +++ b/Content/Templates/Compacte-Voorfase/Doelgroep.md @@ -1,6 +1,6 @@ ## Doelgroep -Dit document is in eerste instantie bestemd voor medewerkers van {de opdrachtgevende organisatie} die {het product} laat ontwikkelen. Het biedt ook inzicht en overzicht aan andere betrokkenen bij het project, namelijk: +Dit document is in eerste instantie bestemd voor medewerkers van {opdrachtgevende organisatie} die {het product} laat ontwikkelen. Het biedt ook inzicht en overzicht aan andere betrokkenen bij het project, namelijk: * de ontwikkelaar(s) van het systeem, * de beheerder(s) van het systeem. diff --git a/Content/Templates/Detailtestplan-Softwarerealisatie/Doelgroep.md b/Content/Templates/Detailtestplan-Softwarerealisatie/Doelgroep.md index e19792e7..3a787af7 100644 --- a/Content/Templates/Detailtestplan-Softwarerealisatie/Doelgroep.md +++ b/Content/Templates/Detailtestplan-Softwarerealisatie/Doelgroep.md @@ -1,3 +1,3 @@ ## Doelgroep -Dit document is bedoeld voor iedereen die betrokken is bij het testtraject van {Projectnaam}. +Dit document is bedoeld voor iedereen die betrokken is bij het testtraject van {het project}. diff --git a/Content/Templates/Detailtestplan-Softwarerealisatie/Template-Inhoud.md b/Content/Templates/Detailtestplan-Softwarerealisatie/Template-Inhoud.md index cc9cff74..1e9dff84 100644 --- a/Content/Templates/Detailtestplan-Softwarerealisatie/Template-Inhoud.md +++ b/Content/Templates/Detailtestplan-Softwarerealisatie/Template-Inhoud.md @@ -32,7 +32,7 @@ Binnen het project worden door ICTU de volgende testsoorten onderscheiden en toe + **Performancetesten:** Het testen van de snelheid van afhandeling van bepaalde functies van het systeem onder een vooraf gedefinieerde belasting. Performancetesten vinden bij voorkeur plaats in een productie-like omgeving, maar kunnen ook in een niet-productie-like omgeving plaatsvinden ten behoeve van het volgen van de relatieve performance van verschillende versies van de software. Er vinden zowel een loadtest (normale en piekbelasting), als een duurtest (normale belasting voor langere tijd), als een stresstest (verhogen van de belasting totdat het systeem het begeeft) plaats. De Kwaliteitsaanpak schrijft voor dat er tijdens de realisatiefase performancetesten worden uitgevoerd. Deze worden bij voorkeur automatisch uitgevoerd. Belangrijk is dat de performancetest die op de testomgeving wordt uitgevoerd, niet vanzelfsprekend representatief is voor de productieomgeving. Dit betekent dat een opdrachtgevende organisatie op de eigen productieomgeving een performancetest moet (laten) uitvoeren om te controleren dat er aan de gestelde performance-eisen is voldaan. + **Securitytesten:** Security- en penetratietesten uitgevoerd door een externe partij. Normaliter worden deze minimaal twee maal per jaar of met elke grote release uitgevoerd en niet elke sprint. Securitytesten vinden bij voorkeur plaats in een productie-like omgeving, maar kunnen ook in een niet-productie-like omgeving plaatsvinden ten behoeve van het testen van de beveiliging van de software zelf. De securitytest is inclusief een review van de broncode. Tijdens de realisatie draaien standaard al de volgende securitytesttools mee in de geautomatiseerde pijplijn: SonarQube, OWASP dependency checker, OWASP ZAP en OpenVAS; de bevindingen die uit deze tools komen worden meteen tijdens de realisatie van het systeem opgepakt. * **Integratietesten:** Tijdens deze test wordt de onderlinge verwerkingswijze tussen de verschillende applicaties getest. Denk hierbij aan gewijzigde applicaties die samen werken met ongewijzigde applicaties. Indien van toepassing zullen hier ook externe systemen bij betrokken worden, in de vorm van stubs. Integratietesten zijn normaal gesproken geautomatiseerde tests. Als onderdeel van de integratietesten wordt getest of de software kan omgaan met fouten in andere applicaties en na een herstart goed blijft functioneren. -* **Gebruikersacceptatietest (GAT):** In tegenstelling tot de ‘traditionele’ watervalmethode biedt agile ontwikkelen meer ruimte voor de gebruiker om te participeren in het ontwikkeltraject. Tijdens elke sprint wordt nieuwe functionaliteit gedemonstreerd door het Scrumteam in een demo-omgeving. {De opdrachtgevende organisatie} en/of beheerorganisatie kan een GAT-testomgeving beschikbaar stellen waar gebruikers kunnen werken met de nieuwe applicaties. Bevindingen worden tijdens trainingen of workshops verzameld om in de backlogs verwerkt te worden. De product owner prioriteert vervolgens deze bevindingen. +* **Gebruikersacceptatietest (GAT):** In tegenstelling tot de ‘traditionele’ watervalmethode biedt agile ontwikkelen meer ruimte voor de gebruiker om te participeren in het ontwikkeltraject. Tijdens elke sprint wordt nieuwe functionaliteit gedemonstreerd door het Scrumteam in een demo-omgeving. {opdrachtgevende organisatie} en/of beheerorganisatie kan een GAT-testomgeving beschikbaar stellen waar gebruikers kunnen werken met de nieuwe applicaties. Bevindingen worden tijdens trainingen of workshops verzameld om in de backlogs verwerkt te worden. De product owner prioriteert vervolgens deze bevindingen. * **Usabilitytesten:** Het doel van deze test is om te bepalen hoe gemakkelijk / toegankelijk het systeem is in het gebruik ervan. Onderdeel van deze test is de toegankelijkheidstest; hiermee wordt bepaald in welke mate de software voldoet aan de wettelijke vereisten van de Web Content Accessibility Guidelines (WCAG2.1) en eventuele aanvullende toegankelijkheidseisen. Deze toegankelijkheidstesten worden waar mogelijk geautomatiseerd uitgevoerd. De toegankelijkheidseisen die niet geautomatiseerd getest kunnen worden, worden periodiek handmatig getest. ## Agile werkwijze diff --git a/Content/Templates/Detailtestplan-Softwarerealisatie/Uitgangspunten.md b/Content/Templates/Detailtestplan-Softwarerealisatie/Uitgangspunten.md index e7ae2f9c..d813a9db 100644 --- a/Content/Templates/Detailtestplan-Softwarerealisatie/Uitgangspunten.md +++ b/Content/Templates/Detailtestplan-Softwarerealisatie/Uitgangspunten.md @@ -4,7 +4,7 @@ De volgende uitgangspunten zijn van toepassing op dit document: | Volgnummer | Uitgangspunt | |:-----|:----| -| U01 | De realisatie van de software wordt door ICTU uitgevoerd. Het beheer wordt door {Beheerorganisatie} uitgevoerd. | +| U01 | De realisatie van de software wordt door ICTU uitgevoerd. Het beheer wordt door {beheerorganisatie} uitgevoerd. | | U02 | De als testbasis geïdentificeerde documenten dienen door alle acceptanten, inclusief het testteam, te zijn geaccordeerd, alvorens met de testspecificatie kan worden begonnen. | | U03 | Per release of per sprint kan de product owner besluiten om bepaalde functionaliteit, bijvoorbeeld geleverd door externe partijen, niet te testen. Indien dit voorkomt, dan zal dit expliciet worden opgenomen in de managementsamenvatting van het vrijgaveadvies. | | U04 | De multidisciplinaire samenstelling van de Scrumteams — test engineers en ontwikkelaars zitten in hetzelfde team — geeft mogelijkheid tot snelle interactie. Issues gevonden binnen een sprint kunnen hierdoor vaak nog binnen dezelfde sprint worden opgelost en hoeven dus niet apart geadministreerd te worden. | diff --git a/Content/Templates/GFO/Doelgroep.md b/Content/Templates/GFO/Doelgroep.md index e443bbd0..ba4d9031 100644 --- a/Content/Templates/GFO/Doelgroep.md +++ b/Content/Templates/GFO/Doelgroep.md @@ -1,3 +1,3 @@ ## Doelgroep -Dit document is bedoeld voor degenen die direct betrokken zijn bij de realisatie, het beheer en het onderhoud van {de applicatie}: product owners, analisten, ontwikkelaars en beheerders. Daarnaast is het GFO nuttig voor belanghebbenden bij de functionele werking van {de applicatie}, zoals domeinexperts, (vertegenwoordigers van) gebruikers en architecten, om een overzicht te krijgen van de functionaliteit van {de applicatie}. +Dit document is bedoeld voor degenen die direct betrokken zijn bij de realisatie, het beheer en het onderhoud van {het product}: product owners, analisten, ontwikkelaars en beheerders. Daarnaast is het GFO nuttig voor belanghebbenden bij de functionele werking van {het product}, zoals domeinexperts, (vertegenwoordigers van) gebruikers en architecten, om een overzicht te krijgen van de functionaliteit van {het product}. diff --git a/Content/Templates/GFO/Kaders.md b/Content/Templates/GFO/Kaders.md index c5324f40..1a263607 100644 --- a/Content/Templates/GFO/Kaders.md +++ b/Content/Templates/GFO/Kaders.md @@ -1,6 +1,6 @@ ## Kaders -De volgende kaders zijn van toepassing op de functionaliteit van {de applicatie}: +De volgende kaders zijn van toepassing op de functionaliteit van {het product}: | Volgnummer | Kader | |:-----------|:----------| diff --git a/Content/Templates/GFO/Over-dit-document.md b/Content/Templates/GFO/Over-dit-document.md index 9d4191ea..402b2415 100644 --- a/Content/Templates/GFO/Over-dit-document.md +++ b/Content/Templates/GFO/Over-dit-document.md @@ -1,9 +1,9 @@ ## Over dit document -Dit globaal functioneel ontwerp (GFO) beschrijft op hoofdlijnen de functionele werking van {de applicatie}. Het GFO geeft inzicht in de manier waarop {gebruikers} {de applicatie} gebruiken en hoe {de applicatie} samenwerkt met andere applicaties in het applicatielandschap van {de opdrachtgevende organisatie}. Het document bevat een globale beschrijving van wíe met de applicatie wát kan doen, in de vorm van use cases. +Dit globaal functioneel ontwerp (GFO) beschrijft op hoofdlijnen de functionele werking van {het product}. Het GFO geeft inzicht in de manier waarop {gebruikers} {het product} gebruiken en hoe {het product} samenwerkt met andere applicaties in het applicatielandschap van {opdrachtgevende organisatie}. Het document bevat een globale beschrijving van wíe met de applicatie wát kan doen, in de vorm van use cases. {Verwijder één van de volgende twee paragrafen:} Bij elke release levert ICTU een versie van het GFO dat is aangepast aan wat daadwerkelijk is gebouwd. Daartoe geeft het document per use case weer of deze al is gerealiseerd. Ook bevat het GFO de tijdens de realisatiefase genomen of aangepaste ontwerpbesluiten. -Het GFO wordt tijdens de realisatiefase niet onderhouden. Bij overdracht van het onderhoud naar een andere partij zal ICTU in opdracht van {de opdrachtgevende organisatie} en in overleg met de ontvangende partij een actueel GFO maken. +Het GFO wordt tijdens de realisatiefase niet onderhouden. Bij overdracht van het onderhoud naar een andere partij zal ICTU in opdracht van {opdrachtgevende organisatie} en in overleg met de ontvangende partij een actueel GFO maken. diff --git a/Content/Templates/GFO/Template-Inhoud.md b/Content/Templates/GFO/Template-Inhoud.md index b776a2a3..357f85dd 100644 --- a/Content/Templates/GFO/Template-Inhoud.md +++ b/Content/Templates/GFO/Template-Inhoud.md @@ -1,6 +1,6 @@ # Context -Dit hoofdstuk beschrijft de context waarin {de applicatie} zal opereren aan de hand van de organisaties en mensen die {de applicatie} gebruiken, de processen die de applicatie ondersteunt en het applicatielandschap waarbinnen {de applicatie} functioneert. +Dit hoofdstuk beschrijft de context waarin {het product} zal opereren aan de hand van de organisaties en mensen die {het product} gebruiken, de processen die de applicatie ondersteunt en het applicatielandschap waarbinnen {het product} functioneert. ## Betrokken organisaties en gebruikers @@ -16,7 +16,7 @@ Dit hoofdstuk beschrijft de context waarin {de applicatie} zal opereren aan de h # Werking op hoofdlijnen -Dit hoofdstuk beschrijft de werking van {de applicatie} op hoofdlijnen. Het beschrijft de hoofdfuncties die het systeem biedt, de ondersteunende functies, de belangrijkste informatie die het systeem bevat, en de klantreizen. +Dit hoofdstuk beschrijft de werking van {het product} op hoofdlijnen. Het beschrijft de hoofdfuncties die het systeem biedt, de ondersteunende functies, de belangrijkste informatie die het systeem bevat, en de klantreizen. ## Hoofdfuncties @@ -40,12 +40,12 @@ Dit hoofdstuk beschrijft de werking van {de applicatie} op hoofdlijnen. Het besc {Leg bij een update in de realisatiefase vast welke use cases zijn gerealiseerd, eventueel met de rationale en met een verwijzing naar de ontwerpbesluiten (in het SAD) die daarvoor zijn genomen.} -Dit hoofdstuk beschrijft de use cases die {de applicatie} ondersteunt. Per use case worden de volgende aspecten benoemd: +Dit hoofdstuk beschrijft de use cases die {het product} ondersteunt. Per use case worden de volgende aspecten benoemd: * Id: Unieke identificatie van de use case. * Naam: Korte aanduiding van de use case. * Doel: Het resultaat dat de (belangrijkste) actor wil bereiken door middel van de use case. -* Actor(en): Een actor is een persoon of een systeem; de actor gebruikt {de applicatie} om zijn of haar doel te bereiken door middel van de use case. +* Actor(en): Een actor is een persoon of een systeem; de actor gebruikt {het product} om zijn of haar doel te bereiken door middel van de use case. * Precondities: Wat moet er waar zijn om de use case te kunnen starten? * Trigger: Wat start de use case? * Primaire scenario: Beschrijving van de interactie tussen actor en systeem waarmee het doel bereikt wordt. diff --git a/Content/Templates/GFO/Uitgangspunten.md b/Content/Templates/GFO/Uitgangspunten.md index 65da8248..588f29fa 100644 --- a/Content/Templates/GFO/Uitgangspunten.md +++ b/Content/Templates/GFO/Uitgangspunten.md @@ -4,6 +4,6 @@ De volgende uitgangspunten zijn van toepassing op dit document: | Volgnummer | Uitgangspunt | |:-----|:----| -| U01 | Voor het beschrijven van de functionele werking van {de applicatie} worden use cases gebruikt. | +| U01 | Voor het beschrijven van de functionele werking van {het product} worden use cases gebruikt. | | U02 | De use cases worden uitgewerkt tot op het niveau van het primaire scenario. Alleen essentiële alternatieve scenario's worden uitgewerkt. | | {volgnummer} | {uitgangspunt} | diff --git a/Content/Templates/IA/Over-dit-document.md b/Content/Templates/IA/Over-dit-document.md index a420b552..f7fa21ff 100644 --- a/Content/Templates/IA/Over-dit-document.md +++ b/Content/Templates/IA/Over-dit-document.md @@ -1,6 +1,6 @@ ## Over dit document -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. +De infrastructuurarchitectuur (IA) heeft als doel om een globaal overzicht te geven van de technische infrastructuur van {het product}. 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: diff --git a/Content/Templates/IA/Uitgangspunten.md b/Content/Templates/IA/Uitgangspunten.md index 01715ec6..9dbe7f38 100644 --- a/Content/Templates/IA/Uitgangspunten.md +++ b/Content/Templates/IA/Uitgangspunten.md @@ -7,7 +7,7 @@ De volgende uitgangspunten zijn van toepassing op dit document: | U01 | {Toepassing OTAP-omgevingen. NB. Er kan sprake zijn van additionele O-, T- en A-omgevingen, maar ook van omgevingen als pre-productie- en experimenteeromgevingen.} | | U03 | {3-Tier.} | | U03 | {IP-adres onafhankelijkheid. IP-adressen van systemen of systeemonderdelen zijn te wijzigen zonder dat dit een significantie impact heeft op de applicatie, bijvoorbeeld door ontkoppeling middels DNS.} | -| U04 | Communicatie via {netwerk} of {internet}. Systeem-naar-systeemcommunicatie van en naar {systeem} verloopt via {netwerk}. | +| U04 | Communicatie via {netwerk} of {internet}. Systeem-naar-systeemcommunicatie van en naar {het product} verloopt via {netwerk}. | | U05 | {Virtualisatie tenzij. In het kader van schaalbaarheid, flexibiliteit en kosten wordt gebruik gemaakt van virtuele servers tenzij dit technisch niet kan.} | | U06 | {Uitgangspunten met betrekking tot redundantie.} | | {volgnummer} | {uitgangspunt} | diff --git a/Content/Templates/Inwerkplan-Kwaliteitsmanager/Relatie-documenten.md b/Content/Templates/Inwerkplan-Kwaliteitsmanager/Relatie-documenten.md index e35dc37e..3a600c81 100644 --- a/Content/Templates/Inwerkplan-Kwaliteitsmanager/Relatie-documenten.md +++ b/Content/Templates/Inwerkplan-Kwaliteitsmanager/Relatie-documenten.md @@ -4,7 +4,7 @@ Relevant voor dit inwerkplan zijn de volgende documenten: | Titel | Versie | |:---------------------------------------|:--------:| -| Projectstartarchitectuur {projectnaam} | {versie} | -| Niet-functionele eisen {productnaam} | {versie} | -| Kwaliteitsplan {projectnaam} | {versie} | +| Projectstartarchitectuur {het project} | {versie} | +| Niet-functionele eisen {het product} | {versie} | +| Kwaliteitsplan {het project} | {versie} | | {titel} | {versie} | diff --git a/Content/Templates/Kwaliteitsplan/Managementsamenvatting.md b/Content/Templates/Kwaliteitsplan/Managementsamenvatting.md index 533e4627..e0a2b4d8 100644 --- a/Content/Templates/Kwaliteitsplan/Managementsamenvatting.md +++ b/Content/Templates/Kwaliteitsplan/Managementsamenvatting.md @@ -1,4 +1,4 @@ -ICTU hanteert voor het ontwikkelen van maatwerksoftware de $KWALITEITSAANPAK$. Deze Kwaliteitsaanpak houdt in dat ICTU voor elk softwareproject een aantal standaard maatregelen toepast, min of meer onafhankelijk van de precieze eisen die {de opdrachtgevende organisatie} stelt aan de software. Dit kwaliteitsplan geeft een overzicht van deze standaard kwaliteitsmaatregelen. Voor de realisatiefase zijn de belangrijkste maatregelen: +ICTU hanteert voor het ontwikkelen van maatwerksoftware de $KWALITEITSAANPAK$. Deze Kwaliteitsaanpak houdt in dat ICTU voor elk softwareproject een aantal standaard maatregelen toepast, min of meer onafhankelijk van de precieze eisen die {opdrachtgevende organisatie} stelt aan de software. Dit kwaliteitsplan geeft een overzicht van deze standaard kwaliteitsmaatregelen. Voor de realisatiefase zijn de belangrijkste maatregelen: * Het hanteren van expliciete entry-en exitcriteria voor het oppakken en afronden van werk * Het toepassen van het ICTU-kwaliteitssysteem (Quality-time) @@ -7,6 +7,6 @@ ICTU hanteert voor het ontwikkelen van maatwerksoftware de $KWALITEITSAANPAK$. D * Het zichtbaar maken en managen van technische schuld * {Als operationeel beheer onderdeel is van de dienstverlening:} Het bewaken van de kwaliteit van de applicatie in de operatie op aspecten als performance en resource gebruik -Omdat {de opdrachtgevende organisatie} specifieke eisen stelt aan de kwaliteitsaspecten {kwaliteitsaspecten} zullen de volgende extra kwaliteitsmaatregelen worden getroffen om deze eisen te borgen: +Omdat {opdrachtgevende organisatie} specifieke eisen stelt aan de kwaliteitsaspecten {kwaliteitsaspecten} zullen de volgende extra kwaliteitsmaatregelen worden getroffen om deze eisen te borgen: * {Projectspecifieke kwaliteitsmaatregel 1} * {Projectspecifieke kwaliteitsmaatregel 2} diff --git a/Content/Templates/Kwaliteitsplan/Over-dit-document.md b/Content/Templates/Kwaliteitsplan/Over-dit-document.md index 1a054979..02649b09 100644 --- a/Content/Templates/Kwaliteitsplan/Over-dit-document.md +++ b/Content/Templates/Kwaliteitsplan/Over-dit-document.md @@ -1,6 +1,6 @@ ## Over dit document -Kwaliteitsmanagement is gericht op het borgen dat het projectresultaat voldoet aan de kwaliteitseisen van {de opdrachtgevende organisatie} en andere belanghebbenden en aan de kwaliteitsnormen van ICTU. Tegelijkertijd bevordert het de efficiëntie en effectiviteit, en daarmee de doorlooptijd, van het project. Alle betrokkenen in en bij het project dragen bij aan de kwaliteit van producten en processen. De ICTU-projectleider is verantwoordelijk voor het opleveren van een eindresultaat dat voldoet aan de eisen en normen. +Kwaliteitsmanagement is gericht op het borgen dat het projectresultaat voldoet aan de kwaliteitseisen van {opdrachtgevende organisatie} en andere belanghebbenden en aan de kwaliteitsnormen van ICTU. Tegelijkertijd bevordert het de efficiëntie en effectiviteit, en daarmee de doorlooptijd, van het project. Alle betrokkenen in en bij het project dragen bij aan de kwaliteit van producten en processen. De ICTU-projectleider is verantwoordelijk voor het opleveren van een eindresultaat dat voldoet aan de eisen en normen. De $KWALITEITSAANPAK$ (zie bijlagen) ligt ten grondslag aan dit kwaliteitsplan en vereist dat projecten continu voldoen aan de kwaliteitsnormen: diff --git a/Content/Templates/Kwaliteitsplan/Relatie-documenten.md b/Content/Templates/Kwaliteitsplan/Relatie-documenten.md index ab4cc13f..8d312a90 100644 --- a/Content/Templates/Kwaliteitsplan/Relatie-documenten.md +++ b/Content/Templates/Kwaliteitsplan/Relatie-documenten.md @@ -4,6 +4,6 @@ Input voor dit kwaliteitsplan, en dan met name paragraaf 5.16, zijn de volgende | Titel | Versie | |:---------------------------------------|:--------:| -| Projectstartarchitectuur {projectnaam} | {versie} | -| Niet-functionele eisen {productnaam} | {versie} | +| Projectstartarchitectuur {het project} | {versie} | +| Niet-functionele eisen {het product} | {versie} | | {titel} | {versie} | diff --git a/Content/Templates/Kwaliteitsplan/Template-Inhoud.md b/Content/Templates/Kwaliteitsplan/Template-Inhoud.md index f3a752fb..52cabde4 100644 --- a/Content/Templates/Kwaliteitsplan/Template-Inhoud.md +++ b/Content/Templates/Kwaliteitsplan/Template-Inhoud.md @@ -32,7 +32,7 @@ De volgende rapportage/escalatielijnen worden gehanteerd indien kwaliteitsnormen 2. Indien 1. niet tot resultaat leidt, escaleert de kwaliteitsmanager de situatie naar de ICTU-projectleider; 3. Indien 2. niet tot resultaat leidt, escaleert de kwaliteitsmanager de situatie naar het hoofd van de afdeling ICTU Software Expertise (ISE). -Als ontdekte kwaliteitsproblemen daartoe aanleiding geven, worden het kwaliteitsplan en/of Quality-time uitgebreid met nieuwe maatregelen en metrieken om de problemen in de toekomst te signaleren en te voorkomen. Dat gebeurt ook proactief, bijvoorbeeld naar aanleiding van ervaringen in andere projecten of als er nieuwe tools beschikbaar komen. De projectleiders van {de opdrachtgevende organisatie}, de beheerorganisatie en ICTU zorgen er gezamenlijk voor dat de gewenste uitbreidingen worden gerealiseerd. +Als ontdekte kwaliteitsproblemen daartoe aanleiding geven, worden het kwaliteitsplan en/of Quality-time uitgebreid met nieuwe maatregelen en metrieken om de problemen in de toekomst te signaleren en te voorkomen. Dat gebeurt ook proactief, bijvoorbeeld naar aanleiding van ervaringen in andere projecten of als er nieuwe tools beschikbaar komen. De projectleiders van {opdrachtgevende organisatie}, de beheerorganisatie en ICTU zorgen er gezamenlijk voor dat de gewenste uitbreidingen worden gerealiseerd. ## Projectdocumenten @@ -54,7 +54,7 @@ De opstellers verwerken het commentaar. Vervolgens sturen de opstellers een toel Het doel van de voorfase is tweeledig: het voorbereiden van de realisatiefase, zodat ICTU verantwoord een projectovereenkomst kan opstellen voor de realisatiefase, en het identificeren van risico’s die van toepassing zijn op de realisatiefase en het verdere verloop van het project. -{De opdrachtgevende organisatie} zorgt dat het project bij de start van de voorfase inzicht heeft in de informatie die typisch wordt vastgelegd in een projectstartarchitectuur, business impact analysis en privacy impact assessment. Waar nodig werkt {de opdrachtgevende organisatie} de informatie bij tijdens de voorfase en realisatiefase. +{opdrachtgevende organisatie} zorgt dat het project bij de start van de voorfase inzicht heeft in de informatie die typisch wordt vastgelegd in een projectstartarchitectuur, business impact analysis en privacy impact assessment. Waar nodig werkt {opdrachtgevende organisatie} de informatie bij tijdens de voorfase en realisatiefase. Dit kwaliteitsplan wordt opgesteld tijdens de voorfase, maar is tevens al deels van toepassing, in ieder geval aan het eind van de voorfase. Voor de voorfase gelden de onderstaande kwaliteitsmaatregelen. @@ -62,13 +62,13 @@ Dit kwaliteitsplan wordt opgesteld tijdens de voorfase, maar is tevens al deels De kwaliteit van de deliverables wordt mede bepaald door de verwachtingen van de belanghebbenden. Het is van belang dat alle belanghebbenden zijn geïdentificeerd en hun verwachtingen zijn vastgelegd, geanalyseerd en vertaald naar de eisen voor het te implementeren systeem. De belanghebbenden worden geïdentificeerd in het projectvoorstel voor de voorfase. De eisen aan het te ontwikkelen systeem worden vastgelegd in Backlog en NFE-document. -De tijdens de voorfase geïdentificeerde eisen vormen het startpunt van {de opdrachtgevende organisatie} en kunnen gedurende de vervolgfases in overeenstemming met de opdrachtnemer aangepast worden. De product owner vertegenwoordigt gedurende de vervolgfasen de geïdentificeerde belanghebbenden. +De tijdens de voorfase geïdentificeerde eisen vormen het startpunt van {opdrachtgevende organisatie} en kunnen gedurende de vervolgfases in overeenstemming met de opdrachtnemer aangepast worden. De product owner vertegenwoordigt gedurende de vervolgfasen de geïdentificeerde belanghebbenden. ## Verwerking eisen ### Functionele eisen -Het programma van eisen en de projectstartarchitectuur, beide opgesteld door {de opdrachtgevende organisatie}, zijn de basis voor de op te leveren ICTU-documenten, zoals architectuur en ontwerpdocumenten. +Het programma van eisen en de projectstartarchitectuur, beide opgesteld door {opdrachtgevende organisatie}, zijn de basis voor de op te leveren ICTU-documenten, zoals architectuur en ontwerpdocumenten. ### Niet-Functionele eisen @@ -76,7 +76,7 @@ Niet-functionele eisen aan het te ontwikkelen systeem worden vastgelegd op basis Niet-functionele eisen voor onderstaande kwaliteitsattributen worden als volgt verwerkt: -* De informatiebeveiligingseisen worden in een afzonderlijk informatiebeveiligingsplan vastgelegd. De software zal zodanig worden voortgebracht en {in geval van operationeel en/of applicatiebeheer:} beheerd dat deze de BIO-compliance van {de opdrachtgevende organisatie} niet zal hinderen. +* De informatiebeveiligingseisen worden in een afzonderlijk informatiebeveiligingsplan vastgelegd. De software zal zodanig worden voortgebracht en {in geval van operationeel en/of applicatiebeheer:} beheerd dat deze de BIO-compliance van {opdrachtgevende organisatie} niet zal hinderen. * Gebruikskwaliteit (usability) is ingebed in de standaard werkwijze van ICTU voor de realisatie van maatwerksoftware. Dit aspect wordt geborgd door opname in het plan van aanpak, het ontwerp en de testplannen. * Toegankelijkheid is een wettelijke verplichting voor webgebaseerde en mobiele applicaties, zie de EN 301 549 en de WCAG 2.1, niveau A en AA. Toegankelijkheid wordt geborgd via toegankelijkheidstesten, zie de kwaliteitsmaatregelen in paragraaf [Toegankelijkheidstesten](#toegankelijkheidstesten). * Performance- en securityeisen worden via performance- en securitytests geborgd, zie de kwaliteitsmaatregelen in paragraaf [Testen](#testen). Voor de borging van andere niet-functionele eisen moeten projectspecifieke maatregelen getroffen worden. Deze worden in dit kwaliteitsplan opgenomen. @@ -196,9 +196,9 @@ De configuratie van de tools wordt {wel/niet} gedeeld in de broncode-repository. Het project hanteert de volgende werkwijze voor broncodereviews: -* Elke pull request wordt door minimaal {X} ontwikkelaar(s) gereviewed. -* Er zijn {Y} goedkeuringen nodig voordat een pull request mag worden gemerged. -* Na goedkeuring wordt de pull request gemerged door de {ontwikkelaar/reviewer}. +* Elke merge request wordt door minimaal {X} ontwikkelaar(s) gereviewed. +* Er zijn {Y} goedkeuringen nodig voordat een merge request mag worden gemerged. +* Na goedkeuring wordt de merge request gemerged door de {ontwikkelaar/reviewer}. Quality-time bewaakt of de reviews hebben plaatsgevonden. @@ -272,7 +272,7 @@ Deze performancetesten worden uitgevoerd in de {performancetestomgeving}. De loa Quality-time rapporteert over de geautomatiseerde performancetesten. Als de verantwoordelijke tester performancerisico's ontdekt die ook aanwezig zijn in een versie van de software die reeds is opgeleverd, rapporteert de tester deze risico's aan het Scrumteam. Issues die voortkomen uit performancetesten worden opgenomen in Jira met het label "performance_bevinding". -{Als operationeel beheer geen onderdeel is van de dienstverlening:} De testen van ICTU kunnen geen uitsluitsel geven over de uiteindelijke performance in de productie-omgeving: ze geven niet meer dan een relatief resultaat ten opzichte van eerdere testen in dezelfde testomgeving. Toch hanteert ICTU ze als een standaard kwaliteitsmaatregel, vóór de oplevering van een nieuwe versie van de software. Want ze geven het inzicht of de performance voor wat betreft de software geen achteruitgang betekent ten opzichte van de bestaande situatie. De uiteindelijke performance in de productieomgeving dient {de opdrachtgevende organisatie} zelf te (laten) testen. +{Als operationeel beheer geen onderdeel is van de dienstverlening:} De testen van ICTU kunnen geen uitsluitsel geven over de uiteindelijke performance in de productie-omgeving: ze geven niet meer dan een relatief resultaat ten opzichte van eerdere testen in dezelfde testomgeving. Toch hanteert ICTU ze als een standaard kwaliteitsmaatregel, vóór de oplevering van een nieuwe versie van de software. Want ze geven het inzicht of de performance voor wat betreft de software geen achteruitgang betekent ten opzichte van de bestaande situatie. De uiteindelijke performance in de productieomgeving dient {opdrachtgevende organisatie} zelf te (laten) testen. ## Security-testen diff --git a/Content/Templates/NFE/Managementsamenvatting.md b/Content/Templates/NFE/Managementsamenvatting.md index b7d79892..09339be6 100644 --- a/Content/Templates/NFE/Managementsamenvatting.md +++ b/Content/Templates/NFE/Managementsamenvatting.md @@ -1,15 +1,15 @@ -{De applicatie} heeft de volgende functies (PSA, {documentreferentie}): +{het product} heeft de volgende functies (PSA, {documentreferentie}): * {Functie 1} * {Functie 2} * {Functie 3} -Deze functies realiseren gezamenlijk het doel van {de applicatie}, namelijk {het doel}. +Deze functies realiseren gezamenlijk het doel van {het product}, namelijk {het doel}. -Omdat {de applicatie} {rationale} is {kwaliteitsaspect 1} de belangrijkste niet-functionele eigenschap. Dat betekent dat {belangrijkste concrete niet-functionele eis voor kwaliteitsaspect 1}. Daarnaast {volgende niet-functionele eis voor kwaliteitsaspect 1}. +Omdat {het product} {rationale} is {kwaliteitsaspect 1} de belangrijkste niet-functionele eigenschap. Dat betekent dat {belangrijkste concrete niet-functionele eis voor kwaliteitsaspect 1}. Daarnaast {volgende niet-functionele eis voor kwaliteitsaspect 1}. Naast {kwaliteitsaspect 1} is ook {kwaliteitsaspect 2} van groot belang omdat {rationale}. Er geldt dat {belangrijkste concrete niet-functionele eis voor kwaliteitsaspect 2}. Ook geldt dat {volgende niet-functionele eis voor kwaliteitsaspect 2}. Omdat {rationale} is ook {kwaliteitsaspect 3} van belang. Daarom {belangrijkste concrete niet-functionele eis voor kwaliteitsaspect 3}. Ook zal {volgende niet-functionele eis voor kwaliteitsaspect 3}. -Uiteraard voldoet {de applicatie} aan de wettelijke verplichting voor toegankelijkheid (de A en AA-eisen uit WCAG v2.1). +Uiteraard voldoet {het product} aan de wettelijke verplichting voor toegankelijkheid (de A en AA-eisen uit WCAG v2.1). diff --git a/Content/Templates/NFE/Over-dit-document.md b/Content/Templates/NFE/Over-dit-document.md index 3b44d711..63d84161 100644 --- a/Content/Templates/NFE/Over-dit-document.md +++ b/Content/Templates/NFE/Over-dit-document.md @@ -1,6 +1,6 @@ ## Over dit document -Dit document beschrijft de niet-functionele eisen aan {systeem}. Basis voor de niet-functionele eisen zijn de kwaliteitsattributen zoals gedefinieerd in de standaard NEN-ISO/IEC 25010. Deze standaard onderscheidt een "Product Quality model" en een "Quality-in-Use model". Dit document richt zich op het Product Quality model. +Dit document beschrijft de niet-functionele eisen aan {het product}. Basis voor de niet-functionele eisen zijn de kwaliteitsattributen zoals gedefinieerd in de standaard NEN-ISO/IEC 25010. Deze standaard onderscheidt een "Product Quality model" en een "Quality-in-Use model". Dit document richt zich op het Product Quality model. NEN-ISO/IEC 25010 definieert de kwaliteitseigenschappen voor een softwareproduct. Deze zijn onderverdeeld in acht hoofdeigenschappen: Functionele geschiktheid, Efficiëntie, Uitwisselbaarheid, Bruikbaarheid, Betrouwbaarheid, Beveiligbaarheid, Onderhoudbaarheid en Overdraagbaarheid. diff --git a/Content/Templates/NFE/Template-Inhoud.md b/Content/Templates/NFE/Template-Inhoud.md index 4165141b..d3eab675 100644 --- a/Content/Templates/NFE/Template-Inhoud.md +++ b/Content/Templates/NFE/Template-Inhoud.md @@ -112,7 +112,7 @@ Merk op dat de [Axe-core regels die als "experimenteel" zijn gemarkeerd](https:/ ## Taal en leesbaarheid -Naast de aan NEN-ISO/IEC 25010 ontleende hoofdeigenschap bruikbaarheid zijn voor de gebruikskwaliteit van {de applicatie} van belang: +Naast de aan NEN-ISO/IEC 25010 ontleende hoofdeigenschap bruikbaarheid zijn voor de gebruikskwaliteit van {het product} van belang: * Taal: welke talen dienen te worden ondersteund. * Leesbaarheid: teksten moeten makkelijk te lezen zijn. Korte zinnen hebben de voorkeur. Hoe gemakkelijker de zin en de woorden, hoe beter de leesbaarheid. diff --git a/Content/Templates/PvA-Realisatiefase/Doelgroep.md b/Content/Templates/PvA-Realisatiefase/Doelgroep.md index 255920d3..66ada8aa 100644 --- a/Content/Templates/PvA-Realisatiefase/Doelgroep.md +++ b/Content/Templates/PvA-Realisatiefase/Doelgroep.md @@ -2,6 +2,6 @@ Dit plan van aanpak is in eerste instantie bestemd voor de opdrachtgever van {opdrachtgevende organisatie}. Het plan biedt ook inzicht en overzicht aan andere betrokkenen bij het project, onder wie projectmedewerkers van ICTU. -ICTU voert de realisatiefase uit in nauwe samenwerking met {samenwerkende partijen}, waarbij ICTU zo goed mogelijk gebruik maakt van de bij {partijen} aanwezige kennis en producten. Dit vraagt, naast de inspanning van ICTU, ook significante inzet van medewerkers van {partijen}; zie hiervoor het hoofdstuk "Werkwijze". +ICTU voert de realisatiefase uit in nauwe samenwerking met {partijen}, waarbij ICTU zo goed mogelijk gebruik maakt van de bij deze partijen aanwezige kennis en producten. Dit vraagt, naast de inspanning van ICTU, ook significante inzet van medewerkers van {partijen}; zie hiervoor het hoofdstuk "Werkwijze". {Als de beheerorganisatie bij start van de realisatiefase nog niet bekend is, vormt dat waarschijnlijk een aanzienlijk risico voor het project. Als operationeel beheer onderdeel is van de dienstverlening is dit zelfs onoverkomelijk. Benoem hier dat deze onbekende partij wel degelijk tot de doelgroep van dit document behoort. Verwijs naar het hoofdstuk "Werkwijze" voor de getroffen maatregelen om de late keuze voor een beheerorganisatie zoveel mogelijk te ondervangen. Verwijs naar gemaakte aannames rond zaken als productieplatform, releaseprocessen en beheerfunctionaliteit.} diff --git a/Content/Templates/PvA-Realisatiefase/Over-dit-document.md b/Content/Templates/PvA-Realisatiefase/Over-dit-document.md index dbe0374d..a30fee29 100644 --- a/Content/Templates/PvA-Realisatiefase/Over-dit-document.md +++ b/Content/Templates/PvA-Realisatiefase/Over-dit-document.md @@ -4,9 +4,9 @@ Bij de uitvoering van softwareontwikkelprojecten hanteert ICTU de $KWALITEITSAANPAK$. Conform deze aanpak volgt na de voorfase een realisatiefase, waarin de software wordt ontwikkeld. -Tijdens de voorfase {voorfaseproject} zijn de volgende activiteiten uitgevoerd: +Tijdens de voorfase van {het project} zijn de volgende activiteiten uitgevoerd: -1. Vaststellen of het mogelijk is om binnen de door {de opdrachtgevende organisatie} gestelde kaders productierijpe software op te leveren {en operationeel te beheren} met de gevraagde functionaliteit en kwaliteit, en zo ja, onder welke randvoorwaarden. Hierbij wordt gekeken naar: +1. Vaststellen of het mogelijk is om binnen de door {opdrachtgevende organisatie} gestelde kaders productierijpe software op te leveren {en operationeel te beheren} met de gevraagde functionaliteit en kwaliteit, en zo ja, onder welke randvoorwaarden. Hierbij wordt gekeken naar: a. techniek (zoals platform, voortbrengingsproces software en koppelingen), a. scope, a. planning, @@ -14,4 +14,4 @@ Tijdens de voorfase {voorfaseproject} zijn de volgende activiteiten uitgevoerd: a. risico’s. 1. Voorbereiden van een eventuele start van de realisatie, zodat het Scrumteam van een voldoende uitgewerkte backlog is voorzien bij de start. -Om tot {projectresultaat} te komen, ontwikkelt ICTU in samenwerking met {partijen} {de software}; zie voor een beschrijving hiervan het hoofdstuk "Producten". Dit plan van aanpak beschrijft verder de planning van en werkwijze tijdens de realisatiefase. Het is een aanvulling op het voorstel inclusief projectovereenkomst {titel, versie en datum}. +Om tot {projectresultaat} te komen, ontwikkelt ICTU in samenwerking met {partijen} {het product}; zie voor een beschrijving hiervan het hoofdstuk "Producten". Dit plan van aanpak beschrijft verder de planning van en werkwijze tijdens de realisatiefase. Het is een aanvulling op het voorstel inclusief projectovereenkomst {titel, versie en datum}. diff --git a/Content/Templates/PvA-Realisatiefase/Relatie-documenten.md b/Content/Templates/PvA-Realisatiefase/Relatie-documenten.md index ef5d9b1e..db0c67cd 100644 --- a/Content/Templates/PvA-Realisatiefase/Relatie-documenten.md +++ b/Content/Templates/PvA-Realisatiefase/Relatie-documenten.md @@ -1,6 +1,6 @@ ## Relatie met andere documenten -De realisatiefase is een vervolg op de voorfase {voorfaseproject}. De documenten die in die voorfase zijn gerealiseerd en die uitgangspunt zijn voor dit plan van aanpak zijn: +De realisatiefase is een vervolg op de voorfase van {het project}. De documenten die in die voorfase zijn gerealiseerd en die uitgangspunt zijn voor dit plan van aanpak zijn: * Projectstartarchitectuur (PSA), versie {versie}, * Business impact analysis (BIA), versie {versie}, diff --git a/Content/Templates/PvA-Realisatiefase/Template-Inhoud.md b/Content/Templates/PvA-Realisatiefase/Template-Inhoud.md index 2d175061..de84fa83 100644 --- a/Content/Templates/PvA-Realisatiefase/Template-Inhoud.md +++ b/Content/Templates/PvA-Realisatiefase/Template-Inhoud.md @@ -26,7 +26,7 @@ ICTU levert de volgende producten en diensten op: ## Scope -Binnen de scope van de opdracht valt de {ontwikkeling en/of het onderhoud} van {de software}, inclusief: +Binnen de scope van de opdracht valt de {ontwikkeling en/of het onderhoud} van {het product}, inclusief: * Ontwikkel, test- en demo-omgevingen, * Engineering tools voor versiebeheer (GitLab of Azure DevOps), bouwen en testen (Azure DevOps, GitLab en/of Jenkins), kwaliteitscontrole (SonarQube), beveiligingscontrole (SonarQube, OWASP Dependency Checker, OWASP ZAP, OpenVAS), toegankelijkheid (Axe), performancetesten (JMeter) en integrale kwaliteitsrapportage (Quality-time), @@ -44,13 +44,13 @@ Binnen de scope van de opdracht valt de {ontwikkeling en/of het onderhoud} van { # Werkwijze -Het succes van het uit te voeren realisatietraject is sterk afhankelijk van de beschikbaarheid en inzet van alle betrokkenen. Deze betrokkenheid dient daarom voor aanvang van het project expliciet te worden geborgd door de betrokken organisaties. Dit zal door de projectleider ICTU en {de opdrachtgevende organisatie} gemonitord worden. +Het succes van het uit te voeren realisatietraject is sterk afhankelijk van de beschikbaarheid en inzet van alle betrokkenen. Deze betrokkenheid dient daarom voor aanvang van het project expliciet te worden geborgd door de betrokken organisaties. Dit zal door de projectleider ICTU en {opdrachtgevende organisatie} gemonitord worden. ## Scrum-aanpak Tijdens dit project wordt agile gewerkt volgens de Scrum-aanpak. ICTU propageert de kernwaarden van Scrum. Dit vertaalt zich concreet in: -* Een Scrumteam, bestaande uit een product owner, door {de opdrachtgevende organisatie} aangesteld, die de uiteindelijke inhoudelijke keuzes maakt, en ontwikkelaars (zoals programmeurs, testers en ontwerpers) en een Scrummaster, door ICTU aangesteld. +* Een Scrumteam, bestaande uit een product owner, door {opdrachtgevende organisatie} aangesteld, die de uiteindelijke inhoudelijke keuzes maakt, en ontwikkelaars (zoals programmeurs, testers en ontwerpers) en een Scrummaster, door ICTU aangesteld. * Een proces met sprints van {twee of drie} weken waarin de Scrumactiviteiten sprint planning, sprint refinement, daily scrum, sprint demonstratie/review en retrospective plaatsvinden. * Een definition of ready en een definition of done voor respectievelijk het beginnen en afronden van werk. * Een product backlog en een sprint backlog. @@ -79,9 +79,9 @@ Voor een goede start wordt er, bij aanvang van de realisatiefase, een kick-off g ## Samenwerking -{Opdrachtgevende organisatie, andere partijen} en ICTU werken gezamenlijk aan de op te leveren software in een Scrumteam. Voor een goed resultaat is het van belang dat er minimaal {aantal} {dagen/dagdelen} per week door alle partijen wordt samengewerkt. {partij} stelt hiervoor {fysieke en/of online} ruimte en samenwerkhulpmiddelen beschikbaar; projectmedewerkers zorgen zelf voor een laptop. {Als met hulpmiddelen van ICTU wordt gewerkt: Om deze bij ICTU te gebruiken moeten de laptops voldoen aan de bij ICTU geldende beveiligingsnormen, welke zijn opgenomen in het ICTU-voorschrift Zakelijk gebruik ICT-diensten en voorzieningen.} +{opdrachtgevende organisatie}, {partijen} en ICTU werken gezamenlijk aan de op te leveren software in een Scrumteam. Voor een goed resultaat is het van belang dat er minimaal {aantal} {dagen/dagdelen} per week door alle partijen wordt samengewerkt. {partij} stelt hiervoor {fysieke en/of online} ruimte en samenwerkhulpmiddelen beschikbaar; projectmedewerkers zorgen zelf voor een laptop. {Als met hulpmiddelen van ICTU wordt gewerkt: Om deze bij ICTU te gebruiken moeten de laptops voldoen aan de bij ICTU geldende beveiligingsnormen, welke zijn opgenomen in het ICTU-voorschrift Zakelijk gebruik ICT-diensten en voorzieningen.} -Vertegenwoordigers van het project nemen deel aan de volgende overleggen met {de opdrachtgevende organisatie} en de beheerorganisatie: +Vertegenwoordigers van het project nemen deel aan de volgende overleggen met {opdrachtgevende organisatie} en de beheerorganisatie: * het architectuuroverleg, * het informatiebeveiligingsoverleg, * het beheeroverleg, @@ -93,22 +93,22 @@ Vertegenwoordigers van het project nemen deel aan de volgende overleggen met {de ## Oplevering software -De realisatiefase bestaat uit {aantal} sprints. Tijdens elke sprint verwerkt het Scrumteam door de product owner geselecteerde functionaliteit in de software. Geselecteerde functionaliteit die niet afkomt tijdens de sprint kan door de product owner opnieuw geselecteerd worden voor de volgende sprint, of voor een latere sprint. Als er na afronding van de realisatiefase nieuwe wensen of fouten aan het licht komen, dan kan {de opdrachtgevende organisatie} deze later alsnog verwerken of ICTU vragen dit in een eventuele vervolgopdracht uit te voeren. +De realisatiefase bestaat uit {aantal} sprints. Tijdens elke sprint verwerkt het Scrumteam door de product owner geselecteerde functionaliteit in de software. Geselecteerde functionaliteit die niet afkomt tijdens de sprint kan door de product owner opnieuw geselecteerd worden voor de volgende sprint, of voor een latere sprint. Als er na afronding van de realisatiefase nieuwe wensen of fouten aan het licht komen, dan kan {opdrachtgevende organisatie} deze later alsnog verwerken of ICTU vragen dit in een eventuele vervolgopdracht uit te voeren. {Beschrijf hier de afspraken tussen ICTU en de opdrachtgevende organisatie over de opzet van vrijgaveadvies, release notes en goedkeuringsproces.} ## Kwaliteitsbeheersing De kwaliteitsbeheersing is door ICTU beschreven in het Kwaliteitsplan. Eén van de kwaliteitsmaatregelen is dat ICTU een geautomatiseerd kwaliteitssysteem (Quality-time) inricht dat de kwaliteit van de software en het ontwikkelproces bewaakt. De ICTU-kwaliteitsmanager configureert de metrieken in Quality-time en bewaakt de metingen. -## Inzet {opdrachtgevende organisatie/andere partijen} +## Inzet {opdrachtgevende organisatie} en {partijen} -Betrokkenheid van inhoudsdeskundigen van {opdrachtgevende organisatie/andere partijen} is randvoorwaardelijk voor de uitvoering van de opdracht. Van de betrokken medewerkers van deze organisatie{s} wordt het volgende verwacht: +Betrokkenheid van inhoudsdeskundigen van {opdrachtgevende organisatie} en {partijen} is randvoorwaardelijk voor de uitvoering van de opdracht. Van de betrokken medewerkers van deze organisatie{s} wordt het volgende verwacht: * Actief bijdragen aan workshops en demo's; * Buiten de workshops uitzoeken van onduidelijkheden en binnen de eigen organisatie(s) op zoek gaan naar antwoorden; * Opstellen, onderhouden en/of reviewen van documenten namens de opdrachtgevende organisatie. -Onderstaand is de verwachte inzet van per rol van {opdrachtgevende organisatie/andere partijen} voor de uitvoering van dit plan van aanpak (één persoon kan eventueel meer dan één rol vervullen): +Onderstaand is de verwachte inzet van per rol van {opdrachtgevende organisatie} en {partijen} voor de uitvoering van dit plan van aanpak (één persoon kan eventueel meer dan één rol vervullen): {Selecteer de juiste rollen en vul aan, vul ook de juiste verantwoordelijkheden in, onderstaande is een eerste opzet met zoveel mogelijk rollen} @@ -138,7 +138,7 @@ Omdat ICTU tijdens het project de software, inclusief documentatie, regelmatig o # Planning en doorlooptijd -De start van het project vindt uiterlijk {aantal} weken na ondertekening van het voorstel inclusief projectovereenkomst plaats. In deze periode bemensen zowel ICTU als {de opdrachtgevende organisatie} het project. Daarbij is rekening gehouden met de doorlooptijd van de werving en selectie van de geschikte mensen. +De start van het project vindt uiterlijk {aantal} weken na ondertekening van het voorstel inclusief projectovereenkomst plaats. In deze periode bemensen zowel ICTU als {opdrachtgevende organisatie} het project. Daarbij is rekening gehouden met de doorlooptijd van de werving en selectie van de geschikte mensen. De verwachte doorlooptijd van de uitvoering van dit plan van aanpak is {aantal} weken. @@ -163,7 +163,7 @@ Voor de uitvoering van de realisatiefase gelden de volgende randvoorwaarden: | Nr | Randvoorwaarde | |:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------| -| R01 | De vereiste inzet van betrokkenen van {de opdrachtgevende organisatie/andere partijen} is georganiseerd en gegarandeerd. | +| R01 | De vereiste inzet van betrokkenen van {opdrachtgevende organisatie} en {partijen} is georganiseerd en gegarandeerd. | | R02 | De product owner is gemandateerd om zelfstandig besluiten te nemen over de functionaliteit van de software. | | R03 | Er is een afgestemde en afgesproken werkwijze tussen {opdrachtgevende organisatie}, {beheerorganisatie} en ICTU. Deze is in lijn met de $KWALITEITSAANPAK$. | | R04 | De voorfaseproducten {producten} zijn beschikbaar voor aanvang van de realisatiefase. | @@ -180,7 +180,7 @@ De risico’s worden door het project bijgehouden in het risicolog. De risico’ | Projectrisico | Maatregel | |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Verwachtingen over dit project tussen verschillende partijen ({andere partijen}, ICTU) kunnen niet waargemaakt worden, waardoor vertraging ontstaat | Wekelijks projectoverleg, samenwerken door middel van werkgroepen en fysiek bij elkaar komen, kick-off met alle betrokkenen waarbij opdrachtgever of product owner de productvisie uiteenzet. | +| Verwachtingen over dit project tussen verschillende partijen ({partijen}, ICTU) kunnen niet waargemaakt worden, waardoor vertraging ontstaat | Wekelijks projectoverleg, samenwerken door middel van werkgroepen en fysiek bij elkaar komen, kick-off met alle betrokkenen waarbij opdrachtgever of product owner de productvisie uiteenzet. | | Scope-uitbreiding, gebrek aan focus | Scope bewaken, alleen de scope uitbreiden als dit noodzakelijk is voor {doel} | | Onvoldoende bemensing door vakanties | Rekening houden met langere doorlooptijd dan de (te) eenvoudige rekensom suggereert. | | {Bij DevOps werkwijze} Onduidelijkheid over de verdeling van verantwoordelijkheden tussen DevOps-team en beheerorganisatie (incident management, backup & restore, etc.) | Afspraken over onderlinge samenwerking vastleggen in een dossier afspraken en procedures (DAP). | diff --git a/Content/Templates/PvA-Realisatiefase/Uitgangspunten.md b/Content/Templates/PvA-Realisatiefase/Uitgangspunten.md index 6cfc58b8..648b0518 100644 --- a/Content/Templates/PvA-Realisatiefase/Uitgangspunten.md +++ b/Content/Templates/PvA-Realisatiefase/Uitgangspunten.md @@ -2,9 +2,9 @@ De volgende uitgangspunten zijn van toepassing op dit plan van aanpak: -| Nr | Uitgangspunt | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| U01 | Het werven van personeel voor het uitvoeren van dit project start na ondertekening van het eveneens verstuurde voorstel inclusief projectovereenkomst door {de opdrachtgevende organisatie}. | -| U02 | {de opdrachtgevende organisatie} is verantwoordelijk voor het betrekken van {de andere betrokken partijen} en het tijdig opleveren van reviews. | -| U03 | {de opdrachtgevende organisatie} is verantwoordelijk voor het aanstellen van een product owner met voldoende tijd en mandaat. | -| {volgnummer} | {uitgangspunt} | +| Nr | Uitgangspunt | +|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| U01 | Het werven van personeel voor het uitvoeren van dit project start na ondertekening van het eveneens verstuurde voorstel inclusief projectovereenkomst door {opdrachtgevende organisatie}. | +| U02 | {opdrachtgevende organisatie} is verantwoordelijk voor het betrekken van {partijen} en het tijdig opleveren van reviews. | +| U03 | {opdrachtgevende organisatie} is verantwoordelijk voor het aanstellen van een product owner met voldoende tijd en mandaat. | +| {volgnummer} | {uitgangspunt} | diff --git a/Content/Templates/PvA-Voorfase/Doelgroep.md b/Content/Templates/PvA-Voorfase/Doelgroep.md index 9ca7dea7..662c1c2e 100644 --- a/Content/Templates/PvA-Voorfase/Doelgroep.md +++ b/Content/Templates/PvA-Voorfase/Doelgroep.md @@ -2,6 +2,6 @@ Dit plan van aanpak is in eerste instantie bestemd voor de opdrachtgever van {opdrachtgevende organisatie}. Het plan biedt ook inzicht en overzicht aan andere betrokkenen bij het project, onder wie projectmedewerkers van ICTU. -ICTU voert de voorfase uit in nauwe samenwerking met {samenwerkende partijen}, waarbij ICTU zo goed mogelijk gebruik maakt van de bij {partijen} aanwezige kennis en producten. Dit vraagt, naast de inspanning van ICTU, ook substantiële inzet van medewerkers van {partijen}; zie hiervoor het hoofdstuk "Werkwijze". +ICTU voert de voorfase uit in nauwe samenwerking met {partijen}, waarbij ICTU zo goed mogelijk gebruik maakt van de bij deze partijen aanwezige kennis en producten. Dit vraagt, naast de inspanning van ICTU, ook substantiële inzet van medewerkers van {partijen}; zie hiervoor het hoofdstuk "Werkwijze". {Als de beheerorganisatie bij start van de voorfase nog niet bekend is, vormt dat waarschijnlijk een aanzienlijk risico voor het project. Benoem hier dat deze onbekende partij wel degelijk tot de doelgroep van dit document behoort. Verwijs naar het hoofdstuk "Werkwijze" voor de getroffen maatregelen om de nog niet gemaakte keuze voor een beheerorganisatie zoveel mogelijk te ondervangen. Geef aan dat aannames gemaakt zullen moeten worden rond zaken als productieplatform, releaseprocessen en beheerfunctionaliteit.} diff --git a/Content/Templates/PvA-Voorfase/Over-dit-document.md b/Content/Templates/PvA-Voorfase/Over-dit-document.md index 8f3278ba..be3e896c 100644 --- a/Content/Templates/PvA-Voorfase/Over-dit-document.md +++ b/Content/Templates/PvA-Voorfase/Over-dit-document.md @@ -6,7 +6,7 @@ Bij de uitvoering van softwareontwikkelprojecten hanteert ICTU de $KWALITEITSAAN De voorfase heeft de volgende doelen: -1. Vaststellen of het mogelijk is om binnen de door {de opdrachtgevende organisatie} gestelde kaders productierijpe software op te leveren {en operationeel te beheren} met de gevraagde functionaliteit en kwaliteit, en zo ja, onder welke randvoorwaarden. Hierbij wordt gekeken naar: +1. Vaststellen of het mogelijk is om binnen de door {opdrachtgevende organisatie} gestelde kaders productierijpe software op te leveren {en operationeel te beheren} met de gevraagde functionaliteit en kwaliteit, en zo ja, onder welke randvoorwaarden. Hierbij wordt gekeken naar: a. techniek (zoals platform, voortbrengingsproces software en koppelingen), a. scope, a. planning, diff --git a/Content/Templates/PvA-Voorfase/Template-Inhoud.md b/Content/Templates/PvA-Voorfase/Template-Inhoud.md index 8e22721d..1c135654 100644 --- a/Content/Templates/PvA-Voorfase/Template-Inhoud.md +++ b/Content/Templates/PvA-Voorfase/Template-Inhoud.md @@ -47,8 +47,8 @@ Het succes van deze voorfase, en van het eventueel later uit te voeren realisati Tijdens dit project wordt zoveel mogelijk agile gewerkt volgens de Scrum-aanpak. Dit vertaalt zich concreet in: -* Eén Scrumteam met medewerkers van {opdrachtgevende organisatie/andere partijen} en ICTU werkt minimaal {aantal} dagdelen per week aan de gedefinieerde documenten. -* Er is een product owner door {de opdrachtgevende organisatie} aangesteld die de uiteindelijke inhoudelijke keuzes maakt. +* Eén Scrumteam met medewerkers van {opdrachtgevende organisatie} en {partijen} en ICTU werkt minimaal {aantal} dagdelen per week aan de gedefinieerde documenten. +* Er is een product owner door {opdrachtgevende organisatie} aangesteld die de uiteindelijke inhoudelijke keuzes maakt. * Voor elk product is een inhoudelijk verantwoordelijke, een penvoerder/schrijver en één of meer reviewers. Alle partijen werken constructief samen. Reviews zijn gericht op kwaliteitsverbeteringen. Waar nodig schrijven reviewers mee aan de documenten. * Nieuwe tussentijdse versies van documenten worden kortcyclisch opgeleverd, elke {termijn}. * Alle tussentijdse versies worden gereviewd door {reviewers} binnen de afgesproken termijn (maximaal {aantal} werkdagen). @@ -65,9 +65,9 @@ Voor een goede start wordt er, bij aanvang van de voorfase, een kick-off georgan ## Samenwerking -{Opdrachtgevende organisatie/andere partijen} en ICTU werken gezamenlijk aan de op te leveren documenten in een Scrumteam. Voor een goed resultaat is het van belang dat er minimaal {aantal} {dagen/dagdelen} per week door alle partijen wordt samengewerkt. {partij} stelt hiervoor {fysieke en/of online} ruimte en samenwerkhulpmiddelen beschikbaar; projectmedewerkers zorgen zelf voor een laptop. {Als met hulpmiddelen van ICTU wordt gewerkt: Om deze bij ICTU te gebruiken moeten de laptops voldoen aan de bij ICTU geldende beveiligingsnormen, welke zijn opgenomen in het ICTU-voorschrift Zakelijk gebruik ICT-diensten en voorzieningen.} +{opdrachtgevende organisatie} en {partijen} en ICTU werken gezamenlijk aan de op te leveren documenten in een Scrumteam. Voor een goed resultaat is het van belang dat er minimaal {aantal} {dagen/dagdelen} per week door alle partijen wordt samengewerkt. {partij} stelt hiervoor {fysieke en/of online} ruimte en samenwerkhulpmiddelen beschikbaar; projectmedewerkers zorgen zelf voor een laptop. {Als met hulpmiddelen van ICTU wordt gewerkt: Om deze bij ICTU te gebruiken moeten de laptops voldoen aan de bij ICTU geldende beveiligingsnormen, welke zijn opgenomen in het ICTU-voorschrift Zakelijk gebruik ICT-diensten en voorzieningen.} -Vertegenwoordigers van het project nemen deel aan de volgende overleggen met vertegenwoordigers van {de opdrachtgevende organisatie} en de beheerorganisatie: +Vertegenwoordigers van het project nemen deel aan de volgende overleggen met vertegenwoordigers van {opdrachtgevende organisatie} en de beheerorganisatie: * het architectuuroverleg, * het informatiebeveiligingsoverleg, * het beheeroverleg, @@ -79,7 +79,7 @@ Vertegenwoordigers van het project nemen deel aan de volgende overleggen met ver ## Oplevering producten -De voorfase is op basis van sprints ingericht. Aan het einde van elke sprint zijn alle tot dan toe opgedane inzichten verwerkt in de producten. Na de laatste sprint levert ICTU het geheel op aan {de opdrachtgevende organisatie}. +De voorfase is op basis van sprints ingericht. Aan het einde van elke sprint zijn alle tot dan toe opgedane inzichten verwerkt in de producten. Na de laatste sprint levert ICTU het geheel op aan {opdrachtgevende organisatie}. ## Kwaliteitsbeheersing @@ -92,15 +92,15 @@ De experts reviewen op zaken zoals: * interne en onderlinge consistentie; * volledigheid. -## Inzet {opdrachtgevende organisatie/andere partijen} +## Inzet {opdrachtgevende organisatie} en {partijen} -Betrokkenheid van inhoudsdeskundigen van {opdrachtgevende organisatie/andere partijen} is randvoorwaardelijk voor de uitvoering van de opdracht. Van de betrokken medewerkers van deze organisatie{s} wordt het volgende verwacht: +Betrokkenheid van inhoudsdeskundigen van {opdrachtgevende organisatie} en {partijen} is randvoorwaardelijk voor de uitvoering van de opdracht. Van de betrokken medewerkers van deze organisatie{s} wordt het volgende verwacht: -* De producten worden opgesteld tijdens verschillende werksessies. Aanwezigheid bij de werksessies (welke zoveel mogelijk tijdens de dagdelen waarop {opdrachtgevende organisatie/andere partijen} en ICTU samenwerken worden gepland) en indien gewenst aan vervolgafspraken in dat kader; +* De producten worden opgesteld tijdens verschillende werksessies. Aanwezigheid bij de werksessies (welke zoveel mogelijk tijdens de dagdelen waarop {opdrachtgevende organisatie} en {partijen} en ICTU samenwerken worden gepland) en indien gewenst aan vervolgafspraken in dat kader; * Actief bijdragen aan het schrijven en reviewen van de producten; * Buiten de workshops uitzoeken van onduidelijkheden en binnen de eigen organisatie(s) op zoek gaan naar antwoorden. -Onderstaand is de verwachte inzet per rol van {opdrachtgevende organisatie/andere partijen} voor de uitvoering van dit plan van aanpak (één persoon kan eventueel meer dan één rol vervullen): +Onderstaand is de verwachte inzet per rol van {opdrachtgevende organisatie} en {partijen} voor de uitvoering van dit plan van aanpak (één persoon kan eventueel meer dan één rol vervullen): {Selecteer de juiste rollen en vul aan, vul ook de juiste verantwoordelijkheden in, onderstaande is een eerste opzet met zoveel mogelijk rollen} @@ -125,7 +125,7 @@ Omdat ICTU tijdens het project de documenten regelmatig oplevert is er geen spec {Verwijs naar dit hoofdstuk in hoofdstuk 5 van het voorstel inclusief POK} -De start van het project vindt uiterlijk {aantal} weken na ondertekening van het eveneens verstuurde voorstel inclusief projectovereenkomst plaats. In deze periode bemensen zowel ICTU als {de opdrachtgevende organisatie} het project. Daarbij is rekening gehouden met de doorlooptijd van de werving en selectie van de geschikte mensen. +De start van het project vindt uiterlijk {aantal} weken na ondertekening van het eveneens verstuurde voorstel inclusief projectovereenkomst plaats. In deze periode bemensen zowel ICTU als {opdrachtgevende organisatie} het project. Daarbij is rekening gehouden met de doorlooptijd van de werving en selectie van de geschikte mensen. De verwachte doorlooptijd van de uitvoering van deze voorfase is {aantal} weken. @@ -151,7 +151,7 @@ Voor de uitvoering van de voorfase gelden de volgende randvoorwaarden: | Nr | Randvoorwaarde | |:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------| -| R01 | De vereiste inzet van betrokkenen van {opdrachtgevende organisatie/andere partijen} is georganiseerd en gegarandeerd. | +| R01 | De vereiste inzet van betrokkenen van {opdrachtgevende organisatie} en {partijen} is georganiseerd en gegarandeerd. | | R02 | De product owner is gemandateerd om zelfstandig besluiten te nemen over de inhoud van de producten. | | R03 | Er is een afgestemde en afgesproken werkwijze tussen {opdrachtgevende organisatie}, {beheerorganisatie} en ICTU. Deze is in lijn met de $KWALITEITSAANPAK$. | | R04 | De producten {producten} zijn beschikbaar voor aanvang van de voorfase. | diff --git a/Content/Templates/PvA-Voorfase/Uitgangspunten.md b/Content/Templates/PvA-Voorfase/Uitgangspunten.md index 6f55cd5b..f6aa1db6 100644 --- a/Content/Templates/PvA-Voorfase/Uitgangspunten.md +++ b/Content/Templates/PvA-Voorfase/Uitgangspunten.md @@ -4,7 +4,7 @@ De volgende uitgangspunten zijn van toepassing op dit plan: | Nr | Uitgangspunt | |:-------------|:----------------------------------------------------------------------------------------------------------------------------------| -| U01 | Het werven van personeel voor het uitvoeren van dit project start na ondertekening van het eveneens verstuurde voorstel inclusief projectovereenkomst door {de opdrachtgevende organisatie}. | -| U02 | {de opdrachtgevende organisatie} is verantwoordelijk voor het betrekken van eventuele andere partijen bij het project en het tijdig opleveren van reviews. | -| U03 | {de opdrachtgevende organisatie} is verantwoordelijk voor het aanstellen van een product owner met voldoende tijd en mandaat. | +| U01 | Het werven van personeel voor het uitvoeren van dit project start na ondertekening van het eveneens verstuurde voorstel inclusief projectovereenkomst door {opdrachtgevende organisatie}. | +| U02 | {opdrachtgevende organisatie} is verantwoordelijk voor het betrekken van eventuele andere partijen bij het project en het tijdig opleveren van reviews. | +| U03 | {opdrachtgevende organisatie} is verantwoordelijk voor het aanstellen van een product owner met voldoende tijd en mandaat. | | {volgnummer} | {uitgangspunt} | diff --git a/Content/Templates/SAD/Doelgroep.md b/Content/Templates/SAD/Doelgroep.md index 2b6945aa..b0a052a9 100644 --- a/Content/Templates/SAD/Doelgroep.md +++ b/Content/Templates/SAD/Doelgroep.md @@ -1,3 +1,3 @@ ## Doelgroep -Dit document is bedoeld voor iedereen die kennis wil of behoort te hebben van de software-architectuur van {de applicatie}, waaronder IT-architecten, ontwikkelaars en testers. +Dit document is bedoeld voor iedereen die kennis wil of behoort te hebben van de software-architectuur van {het product}, waaronder IT-architecten, ontwikkelaars en testers. diff --git a/Content/Templates/SAD/Over-dit-document.md b/Content/Templates/SAD/Over-dit-document.md index 7fbfdbd9..4ed4e049 100644 --- a/Content/Templates/SAD/Over-dit-document.md +++ b/Content/Templates/SAD/Over-dit-document.md @@ -1,3 +1,3 @@ ## Over dit document -Dit Software-architectuurdocument (SAD) beschrijft de software-architectuur van {de applicatie}. Het beschrijft op hoofdlijnen de softwarecomponenten, hun functies en hun onderlinge interacties en samenhang voor specifieke use cases. Het SAD heeft niet het detailniveau van een technisch ontwerp; dat wordt tijdens de realisatie verder uitgewerkt. +Dit Software-architectuurdocument (SAD) beschrijft de software-architectuur van {het product}. Het beschrijft op hoofdlijnen de softwarecomponenten, hun functies en hun onderlinge interacties en samenhang voor specifieke use cases. Het SAD heeft niet het detailniveau van een technisch ontwerp; dat wordt tijdens de realisatie verder uitgewerkt. diff --git a/Content/Templates/SAD/Template-Inhoud.md b/Content/Templates/SAD/Template-Inhoud.md index 515ae486..c6fe5aaa 100644 --- a/Content/Templates/SAD/Template-Inhoud.md +++ b/Content/Templates/SAD/Template-Inhoud.md @@ -29,13 +29,13 @@ Componenten uit een laag mogen alleen componenten uit dezelfde of een diepere la ## Gebruik van bewezen componenten en standaarden -{De applicatie} is gebaseerd op industriestandaarden {opsomming van standaarden}. Om deze standaarden te implementeren gebruikt {de applicatie} gangbare componenten en bibliotheken, bij voorkeur die onderdeel uitmaken van beheerde platformen. Gebruik van gangbare, bewezen en actief onderhouden componenten verlaagt de beheerlast op langere termijn; gebruik van beheerde en volwassen componenten verlaagt beveiligingsrisico's. +{het product} is gebaseerd op industriestandaarden {opsomming van standaarden}. Om deze standaarden te implementeren gebruikt {het product} gangbare componenten en bibliotheken, bij voorkeur die onderdeel uitmaken van beheerde platformen. Gebruik van gangbare, bewezen en actief onderhouden componenten verlaagt de beheerlast op langere termijn; gebruik van beheerde en volwassen componenten verlaagt beveiligingsrisico's. De toegankelijkheid van de applicatie voldoet aan de WCAG 2.1 (Web Content Accessibility Guidelines). ## Gebruik van gangbare security-ontwerpprincipes -{De Applicatie} maakt gebruik van de volgende gangbare security-ontwerpprincipes: +{het product} maakt gebruik van de volgende gangbare security-ontwerpprincipes: * **Least common mechanism**: Minimaliseer gedeelde resources tussen verschillende functies of gebruikers. * **Least privilege**: Ken de minimale rechten toe die nodig zijn voor de adequate uitvoering van elke rol en taak. @@ -115,7 +115,7 @@ In situaties waarin het niet op voorhand duidelijk is wat de correcte reactie va ## Scope -Dit hoofdstuk beschrijft de algemene richtlijnen voor de implementatie van {de applicatie} en de belangrijkste aspecten met betrekking tot de realisatie van de componenten. +Dit hoofdstuk beschrijft de algemene richtlijnen voor de implementatie van {het product} en de belangrijkste aspecten met betrekking tot de realisatie van de componenten. ## Implementatierichtlijnen @@ -159,7 +159,7 @@ Criteria voor de keuze van een programmeertaal voor de implementatie zijn: ## Inleiding -Dit hoofdstuk vat de technische beveiliging van {de applicatie} samen. De maatregelen zijn gegroepeerd naar systeemfunctie en voorzien van verwijzingen naar maatregelen in de risicoanalyse ({referentie}) en het informatiebeveiligingsplan ({referentie}). +Dit hoofdstuk vat de technische beveiliging van {het product} samen. De maatregelen zijn gegroepeerd naar systeemfunctie en voorzien van verwijzingen naar maatregelen in de risicoanalyse ({documentreferentie}) en het informatiebeveiligingsplan ({documentreferentie}). ## Gegevensbeveiliging tijdens transport @@ -208,7 +208,7 @@ Certificaten van anderen: ## Inleiding -Dit hoofdstuk vat de performancekarakteristieken van {de applicatie} samen en beschrijft hoe de benodigde throughput, response tijden en schaalbaarheid bereikt zullen worden. +Dit hoofdstuk vat de performancekarakteristieken van {het product} samen en beschrijft hoe de benodigde throughput, response tijden en schaalbaarheid bereikt zullen worden. ## Belasting diff --git a/Content/Wijzigingsgeschiedenis.md b/Content/Wijzigingsgeschiedenis.md index 8cb64f1e..0a07e1b9 100644 --- a/Content/Wijzigingsgeschiedenis.md +++ b/Content/Wijzigingsgeschiedenis.md @@ -26,12 +26,17 @@ * Paragraaf 3.1.4 "Werkwijze" hernoemd naar "Ontwikkelproces", overeenkomstig maatregel M05 "Het project hanteert een iteratief en incrementeel ontwikkelproces". * De tekst over kwaliteitsnormen uit paragraaf 3.1.4 ondergebracht in een nieuwe paragraaf 3.1.5 "Behalen van kwaliteitsnormen". +* In paragraaf 5.3.3 "Broncodereviews", de term pull request vervangen door merge request omdat dat de terminologie is die in GitLab wordt gebruikt. * Koppeling tussen use cases, logische testgevallen, user stories en epics minder strikt gemaakt in bijlage D "Gebruik van Jira". #### Template Detailtestplan * Template detailtestplan hernoemd naar Template detailtestplan softwarerealisatie om duidelijk te maken dat het alleen gericht is op softwarerealisatie en niet op andere onderwerpen waarvoor een detailtestplan zou kunnen worden gemaakt zoals infrastructuurtesten. +#### Alle templates + +* De labels voor te vervangen teksten geuniformeerd om zoek-en-vervang te vereenvoudigen: {de opdrachtgevende organisatie} vervangen door {opdrachtgevende organisatie}, {(de) applicatie} en {(het) systeem} vervangen door {het product}, {projectnaam} door {het project}, {productnaam} door {het product}, {samenwerkende partijen} door {partijen}, {referentie} door {documentreferentie} en in de colofons aan {naam} ook de rol toegevoegd (bijvoorbeeld {naam projectleider beheerorganisatie}). + #### Self-assessment checklist * Het mogelijk gemaakt bij maatregelen met submaatregelen ook de hoofdmaatregel te scoren.