Skip to content

Commit

Permalink
Verbeter toegankelijkheid.
Browse files Browse the repository at this point in the history
- Voeg alt-tekst toe aan images.
- Verbeter contrast headers met instructies.
- Voeg de cellen van kopjes in de maatregelen tabel niet samen.

Closes #689.
  • Loading branch information
fniessink committed Dec 16, 2024
1 parent 1add224 commit 1070662
Show file tree
Hide file tree
Showing 58 changed files with 641 additions and 56 deletions.
12 changes: 6 additions & 6 deletions Content/Templates/Compacte-Voorfase/Template-Inhoud.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Voor {het product} gelden de volgende functionele eisen, geformuleerd in de vorm van epics. Eisen voor het MVP zijn vetgedrukt.

## {Hoofdfunctie 1, bijvoorbeeld softwareproducten registreren}
## Hoofdfunctie 1 - {naam hoofdfunctie, bijvoorbeeld: Softwareproducten registreren}

{Introductie op hoofdfunctie 1, bijvoorbeeld: Beheerders kunnen softwareproducten registreren, inclusief de versies die beschikbaar zijn bij de leverancier.}

Expand All @@ -11,15 +11,15 @@ Voor {het product} gelden de volgende functionele eisen, geformuleerd in de vorm
1. **{Titel epic 3, bijvoorbeeld: Beschikbare versies registreren}**: Als {rol} wil ik {actie} zodat {doel}. {Bijvoorbeeld: Als beheerder wil ik registreren welke versies van welke softwareproducten bij de leverancier beschikbaar zijn zodat ik kan zien welke software-installaties bijgewerkt kunnen worden.}
1. {Titel epic 4, bijvoorbeeld: Notificatie over nieuwe versies}: {Bijvoorbeeld: Als beheerder wil ik een notificatie ontvangen als er een nieuwe beschikbare versie van een softwareproduct geregistreerd wordt door een collega zodat ik niet zelf regelmatig hoef te kijken of er nieuwe versies beschikbaar zijn. }

## {Hoofdfunctie 2, bijvoorbeeld softwareinstallaties registreren}
## Hoofdfunctie 2 - {naam hoofdfunctie, bijvoorbeeld: Softwareinstallaties registreren}

{Introductie op hoofdfunctie 2, bijvoorbeeld: Bij installatie van een softwareproduct registreren beheerders welke versie van het softwareproduct op welke apparaat wordt geïnstalleerd. Dat maakt het mogelijk te zien wat waar is geïnstalleerd en de geïnstalleerde versies te vergelijken met de beschikbare versies.}

1. **{Titel epic 1, bijvoorbeeld: Registratie van software-installaties}**: Als {rol} wil ik {actie} zodat {doel}. {Bijvoorbeeld: Als beheerder wil ik registreren dat een versie van een softwareproduct op een apparaat is geïnstalleerd zodat ik kan zien welke versies van welke softwareproducten op welke apparaten zijn geïnstalleerd.}
1. **{Titel epic 2, bijvoorbeeld: Overzicht van software-installaties}**: Als {rol} wil ik {actie} zodat {doel}. {Bijvoorbeeld: Als beheerder wil ik bekijken welke versies van welke softwareproducten op welke apparaten zijn geïnstalleerd zodat ik in het geval van nieuwe bekende beveiligingskwetsbaarheden in bepaalde versies van een softwareproduct kan zien op welke apparaten deze versies van het softwareproduct zijn geïnstalleerd.}
1. **{Titel epic 3, bijvoorbeeld: Geïnstalleerde versies vergelijken met beschikbare versies}**: Als {rol} wil ik {actie} zodat {doel}. {Bijvoorbeeld: Als beheerder wil ik de versies van software-installaties vergelijken met de beschikbare versies van de softwareproducten zodat ik kan bepalen of ik een software-installatie kan bijwerken.}

## {Hoofdfunctie 3}
## Hoofdfunctie 3 - {naam hoofdfunctie}

{Vul aan}

Expand All @@ -45,15 +45,15 @@ Onderstaande niet-functionele eisen zijn van toepassing op {het product}:

Het datamodel voor {het product} moet de hieronder beschreven entiteiten ondersteunen.

### {Entiteit 1, bijvoorbeeld: Softwareproduct}
### Entiteit 1 - {naam entiteit, bijvoorbeeld: Softwareproduct}

{Omschrijving van de entiteit, attributen en relaties. Bijvoorbeeld: Een softwareproduct is een applicatie, firmware of besturingssysteem dat geïnstalleerd kan worden op een apparaat. Softwareproducten hebben een naam, een omschrijving en een lijst van tags. Softwareproducten hebben (net als device types) een manufacturer. Softwareproducten hebben een link naar een pagina op een website van de manufacturer met beschikbare versienummers. Softwareproducten hebben nul of meer versies.}

### {Entiteit 2, bijvoorbeeld: Softwareinstallatie}
### Entiteit 2 - {naam entitieit, bijvoorbeeld: Softwareinstallatie}

{Omschrijving van de entiteit, attributen en relaties. Bijvoorbeeld: Een software-installatie is een softwareproduct dat geïnstalleerd is op één specifiek apparaat. Software-installaties hebben een versie, een installatiedatum, een commentaarveld en een lijst van tags. In NetBox kunnen devices services bevatten (services zijn combinaties van protocol en poortnummers en optioneel IP-adressen). Voor softwareproducten ondersteunen we geen services. Gebruikers kunnen bij installatie alleen versienummers invoeren die bij het softwareproduct voorkomen als beschikbaar versienummer.}

### {Entiteit 3}
### Entiteit 3 - {naam entiteit}

{Vul aan}

Expand Down
8 changes: 4 additions & 4 deletions Content/Templates/GFO/Template-Inhoud.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ Dit hoofdstuk beschrijft de use cases die {het product} ondersteunt. Per use cas

De use cases zijn gegroepeerd naar de functies zoals beschreven in het vorige hoofdstuk.

## {F1} - {naam functie 1}
## F1 - {naam functie 1}

Deze paragraaf bevat de use cases behorende bij functie "{functie}".

### {UC1.1} - {naam use case 1.1}
### UC1.1 - {naam use case 1.1}

| Aspect | Beschrijving |
|:------------------|---------------|
Expand All @@ -68,10 +68,10 @@ Deze paragraaf bevat de use cases behorende bij functie "{functie}".
| Primaire scenario | {Wat zijn de stappen in het belangrijkste scenario van de use case} |
| Opmerkingen | {Eventuele toevoegingen en openstaande punten} |

### {UC1.2} - {naam use case 1.2}
### UC1.2 - {naam use case 1.2}

{Kopieer voorgaande subparagraaf om meer use cases toe te voegen.}

## {F2} - {naam functie 2}
## F2 - {naam functie 2}

{Kopieer voorgaande paragraaf om meer functies toe te voegen.}
4 changes: 2 additions & 2 deletions Content/Templates/IA/Template-Inhoud.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ De volgende tabel bevat technische eisen die ten grondslag liggen aan het projec

{Beschrijving OTAP-omgevingen.}

## {Component 1}
## Component 1 - {naam component}

{Beschrijving component}

Expand All @@ -49,7 +49,7 @@ De volgende tabel bevat technische eisen die ten grondslag liggen aan het projec

{Beschrijving van subcomponenten en een gedetailleerde infrastructuurplaat opnemen, indien dit toegevoegde waarde heeft.}

## {Component 2}
## Component 2 - {naam component}

{Beschrijving component}

Expand Down
2 changes: 1 addition & 1 deletion Content/Templates/PvA-Realisatiefase/Template-Inhoud.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ De realisatiefase bestaat uit {aantal} sprints. Tijdens elke sprint verwerkt het

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} en {partijen}
## Verwachte inzet inhoudsdeskundigen

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:

Expand Down
2 changes: 1 addition & 1 deletion Content/Templates/PvA-Voorfase/Template-Inhoud.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ De experts reviewen op zaken zoals:
* interne en onderlinge consistentie;
* volledigheid.

## Inzet {opdrachtgevende organisatie} en {partijen}
## Verwachte inzet inhoudsdeskundigen

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:

Expand Down
8 changes: 4 additions & 4 deletions Content/Templates/SAD/Template-Inhoud.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ In situaties waarin het niet op voorhand duidelijk is wat de correcte reactie va

## Uitwisseling van gegevens met externe systemen

### Koppelvlak {identiteiten- en autorisatiessysteem}
### Koppelvlak 1 - {naam koppelvlak, bijvoorbeeld: Identiteiten- en autorisatiessysteem}

### Koppelvlak {naam 1}
### Koppelvlak 2 - {naam koppelvlak}

### Koppelvlak {naam 2}
### Koppelvlak 3 - {naam koppelvlak}

## Conceptueel gegevensmodel

Expand Down Expand Up @@ -226,6 +226,6 @@ Dit hoofdstuk vat de performancekarakteristieken van {het product} samen en besc

{Beschrijf hoe de applicatie horizontaal danwel verticaal schaalbaar is}

# {Overige architectureel-significante niet-functionele eigenschappen}
# Overige architectureel-significante niet-functionele eigenschappen

{Voeg indien nodig hoofdstukken toe voor andere architectuureel-significante niet-functionele eigenschappen van de applicatie}
2 changes: 1 addition & 1 deletion Content/Templates/Template/Template-Inhoud.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# {Inhoud}
# Inhoud

{De specifieke inhoud van het document}
10 changes: 10 additions & 0 deletions Content/Wijzigingsgeschiedenis.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# Versie 4.0.4, 16 december 2024

## Alle Word-documenten

* Toegankelijkheid verbeterd door alt-tekst toe te voegen aan plaatjes en het contrast van titels met instructies (gele achtergrond) te verbeteren.

## Self-assessment checklist

* Toegankelijkheid verbeterd door cellen niet samen te voegen in de subkopjes van de maatregeltabel.

# Versie 4.0.3, 6 december 2024

## Template Niet-Functionele Eisen
Expand Down
Binary file modified DocumentDefinitions/reference-ictu.docx
Binary file not shown.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ The Kwaliteitsaanpak consists of a main document containing the Kwaliteitsaanpak
1. Create a release branch: `git checkout -b release-vx-y-z`
2. Update the version number and release date in the change log in `./Content/Wijzigingsgeschiedenis.md``
3. Update the version number in `docs/index.html`
3. Update the version number in `pyproject.toml`
4. Create a new release folder in ./docs: `mkdir docs/vx.y.z`
5. Run `VERSION=x.y.z docker compose up` to generate the documents
6. Commit the changes and push to GitHub: `git commit -a -m "Release vx.y.z"; git push`
Expand Down
40 changes: 20 additions & 20 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,28 @@
<body>
<img style="max-width: 100%" src="ICTU.png" alt="ICTU logo">
<p class="title">ICTU Kwaliteitsaanpak Softwareontwikkeling</p>
<h2 class="toc">Release v4.0.3, 6-12-2024</h2>
<h2 class="toc">Release v4.0.4, 16-12-2024</h2>
<p>
<ul>
<li><a href="v4.0.3/ICTU-Kwaliteitsaanpak.zip">Alle bestanden van de ICTU Kwaliteitsaanpak in één Zip-archief</a></li>
<li><a href="v4.0.3/ICTU-Kwaliteitsaanpak.html">ICTU Kwaliteitsaanpak in HTML-formaat</a></li>
<li><a href="v4.0.3/ICTU-Kwaliteitsaanpak.pptx">ICTU Kwaliteitsaanpak Powerpoint presentatie</a></li>
<li><a href="v4.0.3/ICTU-Kwaliteitsaanpak-Samenvatting.html">ICTU Kwaliteitsaanpak samenvatting in HTML-formaat</a></li>
<li><a href="v4.0.3/ICTU-Kwaliteitsaanpak-Checklist.xlsx">ICTU Kwaliteitsaanpak self-assessment Excel-spreadsheet</a></li>
<li><a href="v4.0.3/ICTU-Template-Plan-van-Aanpak-Voorfase.docx">ICTU template plan van aanpak voorfase</a></li>
<li><a href="v4.0.3/ICTU-Template-Plan-van-Aanpak-Realisatiefase.docx">ICTU template plan van aanpak realisatiefase</a></li>
<li><a href="v4.0.3/ICTU-Template-Compacte-Voorfase.docx">ICTU template compacte voorfase</a></li>
<li><a href="v4.0.3/ICTU-Template-Detailtestplan.docx">ICTU template detailtestplan</a></li>
<li><a href="v4.0.3/ICTU-Template-Globaal-Functioneel-Ontwerp.docx">ICTU template globaal functioneel ontwerp</a></li>
<li><a href="v4.0.3/ICTU-Template-Kwaliteitsplan.docx">ICTU template kwaliteitsplan</a></li>
<li><a href="v4.0.3/ICTU-Template-Software-architectuurdocument.docx">ICTU template software-architectuurdocument</a></li>
<li><a href="v4.0.3/ICTU-Template-Inwerkplan-Kwaliteitsmanager.docx">ICTU template inwerkplan kwaliteitsmanager</a></li>
<li><a href="v4.0.3/ICTU-Template-Generiek.docx">ICTU template generiek</a></li>
<li><a href="v4.0.3/Neutraal-Template-Niet-Functionele-Eisen.docx">Neutraal template niet-functionele eisen</a></li>
<li><a href="v4.0.3/Neutraal-Template-Infrastructuurarchitectuur.docx">Neutraal template infrastructuurarchitectuur</a></li>
<li><a href="v4.0.3/Neutraal-Template-Mastertestplan.docx">Neutraal template mastertestplan</a></li>
<li><a href="v4.0.3/Neutraal-Template-Generiek.docx">Neutraal template generiek</a></li>
<li><a href="v4.0.3/ICTU-Kwaliteitsaanpak-Wijzigingsgeschiedenis.html">Wijzigingsgeschiedenis in HTML-formaat</a></li>
<li><a href="v4.0.4/ICTU-Kwaliteitsaanpak.zip">Alle bestanden van de ICTU Kwaliteitsaanpak in één Zip-archief</a></li>
<li><a href="v4.0.4/ICTU-Kwaliteitsaanpak.html">ICTU Kwaliteitsaanpak in HTML-formaat</a></li>
<li><a href="v4.0.4/ICTU-Kwaliteitsaanpak.pptx">ICTU Kwaliteitsaanpak Powerpoint presentatie</a></li>
<li><a href="v4.0.4/ICTU-Kwaliteitsaanpak-Samenvatting.html">ICTU Kwaliteitsaanpak samenvatting in HTML-formaat</a></li>
<li><a href="v4.0.4/ICTU-Kwaliteitsaanpak-Checklist.xlsx">ICTU Kwaliteitsaanpak self-assessment Excel-spreadsheet</a></li>
<li><a href="v4.0.4/ICTU-Template-Plan-van-Aanpak-Voorfase.docx">ICTU template plan van aanpak voorfase</a></li>
<li><a href="v4.0.4/ICTU-Template-Plan-van-Aanpak-Realisatiefase.docx">ICTU template plan van aanpak realisatiefase</a></li>
<li><a href="v4.0.4/ICTU-Template-Compacte-Voorfase.docx">ICTU template compacte voorfase</a></li>
<li><a href="v4.0.4/ICTU-Template-Detailtestplan.docx">ICTU template detailtestplan</a></li>
<li><a href="v4.0.4/ICTU-Template-Globaal-Functioneel-Ontwerp.docx">ICTU template globaal functioneel ontwerp</a></li>
<li><a href="v4.0.4/ICTU-Template-Kwaliteitsplan.docx">ICTU template kwaliteitsplan</a></li>
<li><a href="v4.0.4/ICTU-Template-Software-architectuurdocument.docx">ICTU template software-architectuurdocument</a></li>
<li><a href="v4.0.4/ICTU-Template-Inwerkplan-Kwaliteitsmanager.docx">ICTU template inwerkplan kwaliteitsmanager</a></li>
<li><a href="v4.0.4/ICTU-Template-Generiek.docx">ICTU template generiek</a></li>
<li><a href="v4.0.4/Neutraal-Template-Niet-Functionele-Eisen.docx">Neutraal template niet-functionele eisen</a></li>
<li><a href="v4.0.4/Neutraal-Template-Infrastructuurarchitectuur.docx">Neutraal template infrastructuurarchitectuur</a></li>
<li><a href="v4.0.4/Neutraal-Template-Mastertestplan.docx">Neutraal template mastertestplan</a></li>
<li><a href="v4.0.4/Neutraal-Template-Generiek.docx">Neutraal template generiek</a></li>
<li><a href="v4.0.4/ICTU-Kwaliteitsaanpak-Wijzigingsgeschiedenis.html">Wijzigingsgeschiedenis in HTML-formaat</a></li>
</ul>
</p>
<h2 class="toc">Onderhanden werk</h2>
Expand Down
Binary file added docs/v4.0.4/ICTU-Kwaliteitsaanpak-Checklist.xlsx
Binary file not shown.
Loading

0 comments on commit 1070662

Please sign in to comment.