Nederlandse vertaling van de Standaard voor Publieke Code

Contents

  1. Vereisten
  2. Hoe te testen
  3. Beleidsmakers in de publieke sector: wat je moet doen
  4. Managers: wat je moet doen
  5. Ontwikkelaars en ontwerpers: wat je moet doen
  6. Meer informatie

Contribute on GitHub

Gebruik eenvoudig Engels

Engels is de de facto taal voor samenwerking bij software-ontwikkeling. Sommige contexten vereisen echter andere talen dan Engels. Daarom kan een codebase een aantal hoofdtalen hebben, waaronder Engels.

Informatie van publieke organisaties moet voor iedereen toegankelijk zijn. Duidelijke en eenvoudige taal zorgt ervoor dat de code en wat deze doet, voor een breder publiek begrijpelijk is.

Vertalingen vergroten verder het mogelijke bereik van een codebase. Een taal die gemakkelijk te begrijpen is, verlaagt de kosten voor het maken en onderhouden van vertalingen.

Vereisten

  • De verzameling hoofdtalen voor codebase-documentatie MOET gedocumenteerd zijn.

  • Engels MOET een van de hoofdtalen zijn.

  • Alle documentatie van de codebase MOET up-to-date zijn in alle hoofdtalen.

  • Alle broncode MOET in het Engels zijn opgesteld, behalve wanneer beleid machineleesbaar als code wordt geïnterpreteerd.

  • Al het gebundelde beleid MOET beschikbaar zijn, of een samenvatting hebben, in alle hoofdtalen.

  • Er ZOUDEN GEEN acroniemen, afkortingen, woordspelingen of juridische termen, taaltermen of domeinspecifieke termen in de codebase MOGEN voorkomen zonder voorafgaande uitleg of een verwijzing naar een uitleg.

  • De documentatie ZOU geschreven MOETEN zijn op een eenvoudig taalniveau, zoals aanbevolen door de Web Content Accessibility Guidelines 2.

  • Het verstrekken van extra vertalingen van code, documentatie of tests is OPTIONEEL.

Hoe te testen

  • Controleer of de codebase documenteert welke talen de hoofdtalen zijn.

  • Controleer of de documentatie van de codebase beschikbaar is in het Engels.

  • Controleer of vertalingen in de hoofdtalen dezelfde inhoud hebben.

  • Controleer of de broncode in het Engels is, of controleer of niet-Engelse broncode beleid of terminologie betreft die eerder is uitgelegd.

  • Controleer of alle beleidsregels volledig zijn vertaald of een samenvatting hebben in alle hoofdtalen.

  • Controleer of de documentatie geen onverklaarde acroniemen, afkortingen, woordspelingen of juridische termen, taaltermen of domeinspecifieke termen bevat.

  • Controleer de spelling, grammatica en leesbaarheid van de documentatie.

Beleidsmakers in de publieke sector: wat je moet doen

  • Toets regelmatig bij andere managers, ontwikkelaars en ontwerpers of zij begrijpen wat je levert en hoe je dit documenteert.

Managers: wat je moet doen

  • Bepaal welke talen hoofdtalen zijn voor de codebase-documentatie en verwijs indien van toepassing naar het relevante beleid.

  • Zorg ervoor dat er voldoende personeel of budget is om vertalingen te verzorgen voor de hoofdtalen.

  • Probeer het gebruik van acroniemen, afkortingen, woordspelingen of juridische , taaltermen, of domeinspecifieke termen bij interne communicatie in en tussen teams en belanghebbenden te beperken. Voeg dergelijke termen toe aan een woordenlijst en verwijs ernaar vanaf de plekken waar ze worden gebruikt.

  • Wees kritisch op documentatie en beschrijvingen in voorstellen en wijzigingen. Als je iets niet begrijpt, zullen anderen er waarschijnlijk ook moeite mee hebben.

Ontwikkelaars en ontwerpers: wat je moet doen

  • Controleer regelmatig bij beleidsmakers en managers of zij begrijpen wat je levert en hoe je dit documenteert.

  • Vraag iemand buiten jouw context of hij of zij de inhoud begrijpt (bijvoorbeeld een ontwikkelaar die aan een andere codebase werkt).

  • Als er zowel hoofdvertalingen als ‘best effort’ vertalingen zijn, zorg er dan voor dat duidelijk wordt vastgelegd tot welke categorie elke vertaling behoort.

Meer informatie