Leeswijzer
De standaard beschrijft een aantal criteria. Alle criteria bevatten consistente secties die duidelijk maken hoe je goede publieke code maakt.
Verwijzingen naar beleidsmakers, managers en ontwikkelaars en ontwerpers zijn van toepassing op iedereen die taken uitvoert die verband houden met deze rollen, ongeacht hun functie. Het komt vaak voor dat mensen taken hebben die meerdere rollen omvatten.
Hieronder volgt een korte uitleg van elk van deze secties en hoe ze worden gebruikt binnen de criteria van de standaard.
Inleiding
In deze sectie wordt uitgelegd wat het criterium beoogt te bereiken en waarom het belangrijk is voor de gebruikers en bijdragers van een codebase.
Vereisten
In deze sectie staat wat er gedaan moet worden om aan de Standaard voor Publieke Code te voldoen.
De woorden ‘MOET’, ‘MAG NIET’, ‘ZOU MOETEN’, ‘ZOU NIET MOETEN’, en ‘MAG’ in dit document moeten worden geïnterpreteerd gelijk aan hun Engelstalige tegenhangers (‘MUST’, ‘MUST NOT’, ‘SHOULD’, ‘SHOULD NOT’ en ‘MAY’) zoals beschreven in IETF RFC 2119. Waar deze exacte termen bedoeld zijn worden ze in hoofdletters weergegeven.
De betekenis van deze woorden is:
- MOET: absolute vereiste
- MAG NIET: absoluut verbod
- ZOU MOETEN: sterke wens, tenzij er een valide reden is om er in een specifiek geval vanaf te wijken
- ZOU NIET MOETEN: ongewenst, tenzij er een valide reden is om het in een specifiek geval toe te laten
- MAG: vrije keuze, een optie
Hoe te testen
In deze sectie vind je acties die je kunt ondernemen om te controleren of een bijdrage voldoet aan de standaard. Dit is essentieel als je de Standaard voor Publieke Code in gebruik wilt nemen.
We hebben geprobeerd het zo te formuleren, dat iemand die niet zo bekend is met het onderwerp toch een basiscontrole op naleving kan uitvoeren.
Beleidsmakers in de publieke sector: wat je moet doen
In deze sectie proberen we specifiek beleidsmakers aan te spreken door hen concrete acties aan te bieden die ze in hun rol kunnen uitvoeren.
Beleidsmakers bepalen de prioriteiten en doelen van projecten en hebben mogelijk minder technologische ervaring.
Managers: wat je moet doen
In deze sectie proberen we specifiek managers aan te spreken door hen concrete acties aan te bieden die ze in hun rol kunnen uitvoeren.
Managers zijn verantwoordelijk voor het op tijd opleveren van projecten, het beheer van belanghebbenden en de voortdurende levering van een dienst. Hiervoor zijn ze volledig afhankelijk van beleidsmakers, ontwikkelaars en ontwerpers. Ze moeten de juiste cultuur creëren, de juiste middelen inzetten en de juiste structuren bieden om geweldige diensten te leveren.
Ontwikkelaars en ontwerpers: wat je moet doen
In deze sectie proberen we specifiek ontwikkelaars en ontwerpers aan te spreken door hen concrete acties aan te bieden die ze in hun rol kunnen uitvoeren.
Ontwikkelaars zijn meestal meer technisch onderlegd en hebben meer invloed op de levering van diensten dan de vorige rollen.
Beperking van toepassingsgebied
De Standaard voor Publieke Code is niet bedoeld voor individuele implementaties van een codebase. Dit betekent dat de Standaard voor Publieke Code niet vertelt welke lokale technische infrastructuur en juridische kaders er zijn of hoe je daaraan moet voldoen.
Hoewel de Standaard voor Publieke Code verwijst naar verschillende standaarden en er aanzienlijke overlappingen zijn met andere standaarden, richt de Standaard voor Publieke Code zich specifiek op samenwerking. Daarom is het niet de bedoeling om kwaliteitsstandaarden te vervangen, zoals de ISO 25000-serie, of standaarden die gericht zijn op beveiliging, zoals de OpenSSF Best Practices Badge, maar om er een goede synergie mee te creëren.
En hoewel het doel is om samenwerking mogelijk te maken, is het geen garantie dat er een community ontstaat. Dat vereist nog steeds proactiviteit en ambitie die verder gaan dan het gereedmaken van de codebase voor samenwerking.