Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

eerste versie van vereisten via script #77

Merged
merged 31 commits into from
Apr 11, 2024
Merged
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
0af505d
eerste versie van vereisten via script
ruthkoole Apr 2, 2024
30a0cc9
verwijderen leeg bestand
ruthkoole Apr 2, 2024
e1fde9f
update requirement.txt
ruthkoole Apr 2, 2024
448cba2
verwijderen bestanden met nog onvolledige info
ruthkoole Apr 2, 2024
368f100
fix broken links
ruthkoole Apr 3, 2024
d990af5
verwijderen prints en toevoegen navigatie in footer
ruthkoole Apr 3, 2024
c3113c0
Update index.md
BartdeVisser Apr 4, 2024
3d09529
Update index.md
BartdeVisser Apr 4, 2024
6b1d4a1
Update index.md
BartdeVisser Apr 4, 2024
6137919
Update index.md
BartdeVisser Apr 4, 2024
339bb03
toevoegen van algemene teksten: home, maatregelen, vereisten, rollen,…
ruthkoole Apr 10, 2024
a4aa466
Update index.md
BartdeVisser Apr 10, 2024
092b85e
toevoegen algemene tekst over instrumenten
ruthkoole Apr 10, 2024
2ef77b1
Merge branch 'vereisten-toevoegen' of https://github.com/MinBZK/Algor…
ruthkoole Apr 10, 2024
fc873fd
Update index.md
BartdeVisser Apr 10, 2024
9aed70d
Update index.md
BartdeVisser Apr 10, 2024
412e8d6
Update archiefwet.md
BartdeVisser Apr 10, 2024
550625e
Update index.md
BartdeVisser Apr 10, 2024
304313a
Update index.md
BartdeVisser Apr 10, 2024
0c13114
toevoegen van opmerkingen op bouwblokken pagina en contributing guide…
ruthkoole Apr 10, 2024
91abe4c
toevoegen CONTRIBUTING.md
ruthkoole Apr 10, 2024
1ec99d9
toevoegen toelichting over mkdocs.yml
ruthkoole Apr 10, 2024
80c07ea
Merge branch 'vereisten-toevoegen' of https://github.com/MinBZK/Algor…
ruthkoole Apr 10, 2024
25b6660
update readme met verwijzing naar contributing guidelines
ruthkoole Apr 10, 2024
46ce0fe
fix typo
ruthkoole Apr 10, 2024
eebf862
aanpassen vereisten nav review
ruthkoole Apr 11, 2024
e292c53
aanpassen hoofdlettergebruik in toelichting van vereisten
ruthkoole Apr 11, 2024
48e85c0
kleine wijziging op inkoop pagina en overhetalgoritmekader
ruthkoole Apr 11, 2024
ca498a7
Merge branch 'main' into vereisten-toevoegen
ruthkoole Apr 11, 2024
ee0401d
Merge branch 'vereisten-toevoegen' of https://github.com/MinBZK/Algor…
ruthkoole Apr 11, 2024
1618ab5
fix typo
ruthkoole Apr 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
toevoegen van opmerkingen op bouwblokken pagina en contributing guide…
…lines
ruthkoole committed Apr 10, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 0c13114db63ac34d35a224a712b40d27a98e025e
112 changes: 112 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
# Bijdragen aan het Algoritmekader

Allereerst, bedankt dat je de tijd hebt genomen om een bijdrage te leveren! ❤️

We waarderen alle soorten bijdragen enorm. Zie die [Inhoudsopgave](#inhoudsopgave) voor verschillende manieren waarop je kan bijdragen aan het Algoritmekader.
Zorg ervoor dat je de relevante hoofdstukken even leest voordat je een bijdrage levert.
Het zal het voor het team van het Algoritmekader een stuk makkelijker maken en de ervaring voor alle betrokkenen soepeler laten verlopen.
We kijken uit naar alle bijdragen! 🎉

> ## Opmerking
> Werken in Github is voor het team Algoritmekader nieuw en experimenteel.
> Dit vraagt voor ons om een aangepaste werkwijze en hier is bepaalde expertise voor nodig.
> Het begin is gemaakt en het team Algoritmekader is nog lerende om hier optimaal invulling aan te geven.
> Hierdoor kan het iets langer duren voordat er wordt gereageerd op suggesties of toevoegingen.
> We werken aan een duidelijk proces om hier goed mee om te gaan (deze guidelines zijn daar een voorbeeld van).
> Daarnaast werken we niet aan alle bouwblokken tegelijk. Deze worden één voor één opgepakt.
> Aanbevelingen over onderwerpen die later op de planning staan kunnen daardoor ook iets langer duren om te verwerken, en worden mogelijk pas verwerkt wanneer dit bouwblok wordt uitgewerkt.

## Inhoudsopgave

- [Code of Conduct](#code-of-conduct)
- [Ik heb een vraag](#ik-heb-een-vraag)
- [Ik wil iets bijdragen](#ik-wil-iets-bijdragen)
- [Ik wil een fout of bug melden](#ik-wil-een-fout--bug-melden)
- [Hoe we werken op GitHub](#hoe-we-werken-op-github)

### Code of Conduct
Dit project en iedereen die eraan deelneemt, valt onder de
[Code of Conduct](https://github.com/MinBZK/Algoritmekader?tab=coc-ov-file#readme).
Door deel te nemen, wordt van je verwacht dat je je aan deze code houdt. Meld onacceptabel gedrag
aan **[[email protected]](mailto:[email protected])**.

## Ik heb een vraag

### Maak een issue aan

Voordat je een [Issues](https://github.com/MinBZK/Algoritmekader/issues) gaat aanmaken, kan je bekijken of jouw vraag al tussen de bestaande [Issues](https://github.com/MinBZK/Algoritmekader/issues) staat. Wellicht staat er al een issue tussen die jou vraag kan beantwoorden.

Als je jouw vraag nog steeds wilt stellen, kan je een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aanmaken.

1. Gebruik daarvoor de knop new issue.
2. Schrijf je vraag of opmerking is en geef een heldere toelichting.
3. Anderen kunnen nu opmerkingen toevoegen aan jouw issue.
3. Het team van het Algoritmekader zal deze issue labelen als `question` en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van het Algoritmekader contact op voor een verduidelijking of een oplossing.

### Stel een vraag via mail

Je kan je vragen ook altijd stellen door een mail te sturen naar **[[email protected]](mailto:[email protected])**.

## Ik wil iets bijdragen
Er zijn verschillende manieren waarop je kan bijdragen. Zie hieronder de mogelijkheden.

> #### Ter kennisgeving
> Wanneer je bijdraagt aan dit project, moet je ermee akkoord gaan dat je 100% van de inhoud hebt geschreven, dat je de benodigde rechten op de inhoud hebt en dat de inhoud die je bijdraagt mag worden geleverd onder de Code of Conduct.

### Sluit je aan bij een werkgroep
Voor sommige bouwblokken wordt er gewerkt met werkgroepen, om de informatie verder uit te werken. Deelname aan een werkgroep kost tijd. Werkgroepen komen regelmatig bij elkaar, en tussendoor worden bepaalde zaken uitgewerkt door werkgroepleden. Wil je op één van de onderwerpen meewerken? Stuur dan een bericht naar **[[email protected]](mailto:[email protected])**.

### Neem deel aan een sprint review / klankbord / demo
Het team van het algoritmekader werkt in sprints van ongeveer 3 weken. Daarin werken we toe naar de volgende release van het Algoritmekader. Ongeveer eens in de 6 weken vindt er een nieuwe release plaats. Wanneer er een release is, wordt deze altijd toegelicht en gepresenteerd in een open online review / demo. Deze kan je vrijblijvend volgen. Zo blijf je op de hoogte en kun je een bijdrage leveren. [Bekijk de agenda op Algoritmes Pleio](https://algoritmes.pleio.nl/events) voor de komende bijeenkomsten.

## Ik wil een fout / bug melden
Heb je een foutje gevonden in het Algoritmekader? Dan kan je deze melden door een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aan te maken.

Voordat je een [Issues](https://github.com/MinBZK/Algoritmekader/issues) gaat aanmaken, kan je bekijken of jouw gevonden fout al tussen de bestaande [Issues](https://github.com/MinBZK/Algoritmekader/issues) staat.

Als je de gevonden fout nog steeds wilt melden, kan je een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aanmaken.

1. Gebruik daarvoor de knop new issue.
2. Beschrijf de fout duidelijk en geef een heldere toelichting. Voeg waar mogelijk een screenshot toe.
3. Het team van het Algoritmekader zal deze issue labelen als `bug` en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van het Algoritmekader contact op voor een verduidelijking of een oplossing.

### Ik wil een verbetering voorstellen
Heb je een suggestie of wil je een verbetering voorstellen? Dat kan gaan om een compleet nieuwe functionaliteit van de site of om kleine verbeteringen. Het volgen van onderstaande instructie helpt het team van het algoritmekader om je suggestie te begrijpen en gerelateerde suggesties te vinden.

Je kan een suggestie doen door een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aan te maken of door een Pull Request te maken.

#### Voordat je een suggestie gaat maken

- Voordat je een suggestie gaat maken, kan je bekijken of jouw suggestie al tussen de bestaande [Issues](https://github.com/MinBZK/Algoritmekader/issues) staat. Wellicht bestaat er al een issue die jouw suggestie beschrijft, en zijn we er al mee bezig.
- Zoek uit of jouw idee past binnen het doel en de scope van het project. Wat zijn de voordelen van deze functionaliteit of toevoeging? Het is aan jou om het team van het Algoritmekader en de community te overtuigen dat dit een nuttige toevoeging is aan het Algoritmekader. Houd in gedachten dat we functioanliteiten willen die nuttig zijn
voor de meerderheid van onze gebruikers en niet slechts voor een kleine groep.

#### Een issue aanmaken

Als je jouw suggestie nog steeds wilt doen, kan je een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aanmaken.

1. Gebruik daarvoor de knop new issue.
2. Beschrijf duidelijk jouw suggestie en geef een heldere toelichting en onderbouwing waarom dit een goede toevoeging zal zijn aan het Algoritmekader
3. Het team van het Algoritmekader zal deze issue labelen als `enhancement` en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van het Algoritmekader contact op voor een verduidelijking of een oplossing.

> Afhankelijk van de complexiteit en het onderwerp van jouw suggestie kan het even duren voordat deze wordt opgepakt door het team van het Algoritmekader.

#### Een pull-request maken
Kun je niet uit de voeten met de issues?
Bijvoorbeeld omdat je verschillende wijzigingsvoorstellen wilt doen? Je kan ook gebruik maken van een [Fork en een Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks).

Het team van Algoritmekader bekijkt daarna jouw aanpassingen en kan bij akkoord jouw aanpassingen *mergen*. Er zijn ook andere manieren om een pull request te doen. [Meer daarover](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).

> Afhankelijk van de complexiteit en het onderwerp van jouw suggestie kan het even duren voordat deze wordt opgepakt door het team van het Algoritmekader.

> #### Preview van een pull-request
> We maken gebruik van de tool [pr-preview-action](https://github.com/rossjrw/pr-preview-action) om automatisch previews te maken van een pull-request.
Dit maakt het mogelijk om de wijzigingen die zijn gedaan in een pull-request al te bekijken in de uiteindelijke omgeving.
> Wanneer er een pull-request gedaan wordt via een fork, leidt dit helaas tot een error, zie [Issue #79](https://github.com/MinBZK/Algoritmekader/issues/79). Dit blokkeert de pull-request niet.

### Hoe we werken op Github
We werken met [Markdown](https://www.markdownguide.org/basic-syntax/) bestanden.
Dit is bestandsformaat voor platte tekstbestanden en wordt door veel verschillende tools ondersteund. Dit maakt het eenvoudig om versiebeheer op het Algoritmekader toe te passen.

Daarnaast maken gebruik van [mkdocs](https://www.mkdocs.org/) en [material for mkdocs](https://squidfunk.github.io/mkdocs-material/) om de informatie op een interactieve wijze inzichtelijk te maken op de website van [het Algoritmekader](https://minbzk.github.io/Algoritmekader/).

7 changes: 6 additions & 1 deletion docs/bouwblokken/conformiteitsbeoordeling/index.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,12 @@ summary: Hier staat een korte samenvatting over dit onderwerp
icon: material/check-circle
---

Hier komt een beschrijving van dit bouwblok
Hier komt een beschrijving van dit bouwblok.

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.


## Vereisten

11 changes: 9 additions & 2 deletions docs/bouwblokken/data/index.md
Original file line number Diff line number Diff line change
@@ -4,12 +4,19 @@ summary: Hier staat een korte samenvatting over dit onderwerp
icon: material/database
---

Hier komt een beschrijving van dit bouwblok
Hier komt een beschrijving van dit bouwblok.

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.

## Vereisten

<!-- list_vereisten bouwblok/data -->

## Maatregelen

<!-- list_maatregelen bouwblok/data -->
<!-- list_maatregelen bouwblok/data -->

## Nuttige informatie
- FAIR data: [GO FAIR Foundation](https://www.gofair.foundation/).
7 changes: 6 additions & 1 deletion docs/bouwblokken/duurzaamheid/index.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,12 @@ summary: Hier staat een korte samenvatting over dit onderwerp
icon: material/leaf
---

Hier komt een beschrijving van dit bouwblok
Hier komt een beschrijving van dit bouwblok.

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vindt je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.


## Vereisten

8 changes: 7 additions & 1 deletion docs/bouwblokken/fundamentele-rechten/index.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,13 @@ summary: Hier staat een korte samenvatting over dit onderwerp
icon: material/scale-balance
---

Hier komt een beschrijving van dit bouwblok
Hier komt een beschrijving van dit bouwblok.

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.

Onderdeel van het bouwblok Fundamentele rechten is het onderwerp [Bias en non-discriminatie](non-discriminatie.md).

## Vereisten

63 changes: 15 additions & 48 deletions docs/bouwblokken/fundamentele-rechten/non-discriminatie.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,29 @@
---
title: Non-discriminatie
summary: hier staat een korte samenvatting over dit onderwerp
title: Bias en non-discriminatie
---
!!! info "Disclaimer"

Het Algoritmekader is nog volop in ontwikkeling. Op deze plek willen we vooral aan de slag gaan op een open en transparante wijze. Het is dus niet definitief. Dat betekent dat er dingen opstaan die niet af zijn en soms zelfs fout. Mocht er iets niet kloppen, laat het ons weten via [GitHub](https://github.com/MinBZK/Algoritmekader).

## Waarom?
Schrijf hier een tekst over wat [title] is en waarom dit belangrijk is voor een verantwoord gebruik van algoritmes bij overheidsorganisaties.
Algoritmes worden binnen de overheid veelvuldig ingezet om publieke taken uit te voeren. Dit biedt veel kansen, maar er zijn ook risico's aan verbonden.
Hoewel algoritmes in sommige gevallen kunnen bijdragen aan het tegengaan van discriminatie, kan bias[^1] in het algoritme ook leiden tot een ongelijke en oneerlijke behandeling van burgers of groepen, en kan er ook sprake zijn van discriminerende effecten.
In dit bouwblok van het algoritmekader besteden we aandacht aan de onderwerpen bias, eerlijkheid en non-discriminatie.
We werken uit wat bias is, hoe bias kan ontstaan, hoe we dit kunnen signaleren, welke maatregelen er genomen kunnen worden om dit te voorkomen en geven we handvatten wat te doen wanneer een (onwenselijke) bias is gesignaleerd.

## Levenscyclus
Een overzicht van welke fasen van de levenscyclus relevant zijn voor dit bouwblok.
Hierbij is het goed om op te merken dat het omgaan met het thema bias gedurende het ontwikkelen, inkopen of gebruik van het algoritme vraagt om continue aandacht voor dit onderwerp.
Het betreft geen probleem dat eenmalig kan worden weggenomen, maar het vraagt voortdurende reflectie op eerlijkheid en rechtvaardigheid van het systeem.

- [x] Probleemanalyse
- [x] Ontwerp
- [x] Data verkenning en data preparatie
- [x] Ontwikkelen
- [x] Validatie
- [x] Implementatie
- [x] Monitoren
- [ ] Archiveren
[^1]: In het Nederlands vertaald als vooringenomenheid, vooroordeel of neiging

## Normen
Dit bouwblok wordt uitgewerkt in vereisten die weergeven wat er vanuit wet- en regelgeving en bestaande toetsingskaders vereist is om bias en discriminatie tegen te gaan.
Daarbij worden er suggesties gedaan hoe deze vereisten kunnen worden nageleefd met concrete maatregelen, en welke actoren daarbij betrokken kunnen zijn.
Waar mogelijk worden concrete voorbeelden en best practices uit de praktijk gegeven en zal worden aangegeven bij welk type algoritmen of AI dit relevant is.
Deze vereisten en maatregelen worden ook gekoppeld aan de algoritme levenscyclus.
Dit geeft een beeld van wanneer bepaalde vereisten of maatregelen, bij het ontwikkelen van algoritmen en AI, moeten worden geadresseerd.

Onderstaand een overzicht van de minimale vereisten die volgen uit geldende wet- en regelgeving, toetingskaders en andere bronnen
Door bij de ontwikkeling van algoritmes rekening te houden met vereisten die voorkomen uit wet- en regelgeving, het type algoritme of AI en de potentiële risico’s die ontstaan bij het gebruiken ervan, kunnen negatieve gevolgen worden voorkomen.

=== "Laag risico"

| **Norm** | **Uitleg** | **Bron** |
|-----------------------------------|------------------------------------------|----------|
| Norm 2 | Korte uitleg over norm 2 | |

=== "Hoog risico"

**Norm** | **Uitleg** | **Bron**
-----------------------------------|------------------------------------------|----------
Verbod op ongelijke behandeling in gelijke omstandigheden. Discriminatie wegens godsdienst, levensovertuiging, politieke gezindheid, ras, geslacht of op welke grond dan ook, is niet toegestaan | Korte uitleg over norm 1 | | IKA1.0
Norm 2 | Korte uitleg over norm 2 |
Norm 3 | Korte uitleg over norm 3 |
Norm 4 | Korte uitleg over norm 4 |


## Rollen
Overzicht van welke rollen belangrijk zijn te betrekken bij dit bouwblok.

<div class="grid cards" markdown>

- __technische expert__ bron: handreiking non-discriminatie by design
- __projectleider__ bron: handreiking non-discriminatie by design
- __jurist__ bron: handreiking non-discriminatie by design
- __functionaris gegevensbescherming__ bron: handreiking non-discriminatie by design
- __relevante stakeholders__ bron: handreiking non-discriminatie by design
- __domein expert__ bron: handreiking non-discriminatie by design
- __data steward__ bron: handreiking non-discriminatie by design
- __data analist__ bron: handreiking non-discriminatie by design
- __beleid__ bron: evaluatie handreiking non-discriminatie by design door ADR

</div>
De onderwerpen bias en non-discriminatie spelen daarom een belangrijke rol bij de totstandkoming van verantwoord ontwikkelde algoritmen en AI en het gebruik daarvan door ambtenaren.

## Aanbevelingen
[Rathenau](https://www.rathenau.nl/nl/digitalisering/algoritmes-afwegen)
5 changes: 5 additions & 0 deletions docs/bouwblokken/governance/index.md
Original file line number Diff line number Diff line change
@@ -6,6 +6,11 @@ icon: material/bank

Hier komt een beschrijving van dit bouwblok.

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.


## Vereisten

<!-- list_vereisten bouwblok/governance -->
5 changes: 5 additions & 0 deletions docs/bouwblokken/menselijke-controle/index.md
Original file line number Diff line number Diff line change
@@ -6,6 +6,11 @@ icon: material/account-check

Hier komt een beschrijving van dit bouwblok.

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.


## Vereisten

<!-- list_vereisten bouwblok/menselijke-controle -->
5 changes: 5 additions & 0 deletions docs/bouwblokken/privacy-en-gegevensbescherming/index.md
Original file line number Diff line number Diff line change
@@ -6,6 +6,11 @@ icon: material/shield-lock

Hier komt een beschrijving van dit bouwblok.

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.


## Vereisten

<!-- list_vereisten bouwblok/privacy-en-gegevensbescherming -->
Original file line number Diff line number Diff line change
@@ -4,7 +4,12 @@ summary: Hier staat een korte samenvatting over dit onderwerp
icon: material/cog
---

Hier komt een beschrijving van dit bouwblok
Hier komt een beschrijving van dit bouwblok.

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.


## Vereisten

5 changes: 5 additions & 0 deletions docs/bouwblokken/transparantie/index.md
Original file line number Diff line number Diff line change
@@ -6,6 +6,11 @@ icon: material/magnify

Hier komt een beschrijving van dit bouwblok.

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.


## Vereisten

<!-- list_vereisten bouwblok/transparantie -->