Leeswijzer

De Standard for Public Code beschrijft een aantal criteria. Alle criteria hebben consistente secties die duidelijk maken hoe je goede publieke code kunt creëren.

Verwijzingen naar “beleidsmakers”, “managers” en “ontwikkelaars en ontwerpers” zijn van toepassing op iedereen die taken uitvoert die verband houden met deze rollen, ongeacht hun precieze functietitel. Het is gebruikelijk dat individuen taken hebben die meerdere rollen bestrijken.

Hieronder volgt een korte uitleg van elk van de secties en hoe ze worden gebruikt binnen de criteria van de Standard for Public Code.

Sectie “Inleiding”

Deze sectie legt uit wat het doel is van het criterium en waarom het belangrijk is voor de gebruikers en bijdragers van een codebase.

Sectie “Vereisten”

Deze sectie somt op wat er gedaan moet worden om te voldoen aan de Standard for Public Code.

De woorden “MOET”, “MAG NIET”, “ZOU MOETEN”, “ZOU NIET MOETEN”, en “MAG” in dit document moeten worden geïnterpreteerd gelijk aan hun Engelstalige equivalenten (“MUST”, “MUST NOT”, “SHOULD”, “SHOULD NOT” en “MAY”) als 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 valide reden is in specifiek geval af te wijken
• ZOU NIET MOETEN: ongewenst, tenzij er valide reden is om het in specifiek geval toe te laten
• MAG: vrije keuze, een optie

Sectie “Quickscan”

Deze sectie biedt acties die je kunt ondernemen om te zien of een bijdrage voldoet aan de Standard for Public Code. Dit is cruciaal als je de Standard for Public Code wilt operationaliseren.

We hebben geprobeerd het zo te formuleren dat ook iemand die niet diepgaand bekend is met het onderwerp, toch een basiscontrole op naleving kan uitvoeren.

Sectie “Aanwijzingen voor beleidsmakers”

Deze sectie richt zich specifiek op beleidsmakers door hen concrete acties te bieden die ze in hun rol kunnen uitvoeren.

Publieke beleidsmakers stellen de prioriteiten en doelen van projecten vast en hebben mogelijk minder technologische ervaring.

Sectie “Aanwijzingen voor managers”

Deze sectie richt zich specifiek op managers door hen concrete acties te bieden die ze in hun rol kunnen uitvoeren.

Managers zijn verantwoordelijk voor de tijdige oplevering van projecten, het managen van belanghebbenden en de continue levering van de dienst. Hiervoor zijn ze compleet afhankelijk van zowel beleidsmakers als ontwikkelaars en ontwerpers. Ze moeten de juiste cultuur creëren, de juiste middelen regelen en de juiste structuren bieden om geweldige diensten te leveren.

Sectie “Aanwijzingen voor ontwikkelaars en ontwerpers”

Deze sectie richt zich specifiek op ontwikkelaars en ontwerpers door hen concrete acties te bieden die ze in hun rol kunnen uitvoeren.

Ontwikkelaars zijn meestal meer technisch gericht en hebben meer invloed op de levering van diensten dan de eerdere groepen.

Beperking van de reikwijdte van de Standard for Public Code

De Standard for Public Code is niet bedoeld om individuele implementaties van een codebase te dekken. Dit betekent dat de Standard for Public Code de implementatoren niet vertelt hoe ze moeten voldoen aan de technische infrastructuur of het juridische kader van hun organisatie.

Hoewel de Standard for Public Code naar verschillende standaarden verwijst en aanzienlijke overlap heeft met andere, is het doel van de Standard for Public Code om samenwerking mogelijk te maken. Het is niet de bedoeling om kwaliteitsnormen, zoals de ISO 25000-serie, of die gericht op beveiliging, zoals het OpenSSF Best Practices Badge, te vervangen, maar om daar goed mee samen te gaan.

En hoewel één van de doelen van de Standard for Public Code het mogelijk maken van samenwerking is, kan de Standard for Public Code het niet garanderen dat er een community ontstaat. Dat vereist bovenop het klaarmaken van de codebase voor samenwerking, ook de benodigde proactiviteit en ambitie.