Community Translations of the Standard for Public Code

Contents

  1. Vereisten
  2. Quickscan
  3. Aanwijzingen voor beleidsmakers
  4. Aanwijzingen voor managers
  5. Aanwijzingen voor ontwikkelaars en ontwerpers
  6. Meer informatie

Contribute on GitHub

Gebruik eenvoudig Engels

Engels is de de facto taal van samenwerking in softwareontwikkeling. Sommige contexten vereisen echter andere talen dan Engels. Daarom kan een codebase een set van gezaghebbende talen hebben, waaronder Engels.

Informatie uit de publieke sector moet toegankelijk zijn voor al haar burgers. Eenvoudige en duidelijke taal maakt de code en wat deze doet gemakkelijker te begrijpen voor een breder publiek.

Vertalingen vergroten de mogelijke reikwijdte van een codebase verder. Taal die gemakkelijk te begrijpen is, verlaagt de kosten voor het creëren en onderhouden van vertalingen.

Vereisten

  • De set gezaghebbende talen voor documentatie van de codebase MOET worden gedocumenteerd.
  • Engels MOET een van de gezaghebbende talen zijn.
  • Alle documentatie van de codebase MOET actueel zijn in alle gezaghebbende talen.
  • Alle broncode MOET in het Engels zijn, behalve wanneer beleid als code door machines wordt geïnterpreteerd.
  • Al het meegeleverde beleid MOET beschikbaar zijn, of een samenvatting hebben, in alle gezaghebbende talen.
  • Er ZOUDEN geen acroniemen, afkortingen, woordspelingen of juridische/taalkundige/vakspecifieke termen in de codebase mogen staan zonder een voorafgaande uitleg of een link naar een uitleg.
  • Documentatie ZOU moeten streven naar een leesniveau op het niveau van lager secundair onderwijs, zoals aanbevolen door de Web Content Accessibility Guidelines 2.
  • Het verstrekken van aanvullende vertalingen op basis van beleefdheid van code, documentatie of tests is OPTIONEEL.

Quickscan

  • Bevestig dat de codebase documenteert welke talen gezaghebbend zijn.
  • Bevestig dat de documentatie van de codebase beschikbaar is in het Engels.
  • Bevestig dat vertalingen in gezaghebbende talen dezelfde inhoud hebben.
  • Bevestig dat de broncode in het Engels is, of bevestig dat eventuele niet-Engelse broncode beleid of termen zijn met voorafgaande uitleg.
  • Bevestig dat al het beleid volledig is vertaald of een samenvatting heeft in alle gezaghebbende talen.
  • Controleer of er geen onverklaarde acroniemen, afkortingen, woordspelingen of juridische/taalkundige/vakspecifieke termen in de documentatie staan.
  • Controleer de spelling, grammatica en leesbaarheid van de documentatie.

Aanwijzingen voor beleidsmakers

  • Test regelmatig met andere managers, ontwikkelaars en ontwerpers tijdens het proces of ze begrijpen wat je levert en hoe je het documenteert.

Aanwijzingen voor managers

  • Stel vast welke talen gezaghebbend zijn voor de documentatie van de codebase, met vermelding van relevant beleid indien van toepassing.
  • Zorg ervoor dat er personeel of budget beschikbaar is om vertalingen voor gezaghebbende talen te verzorgen.
  • Probeer het gebruik van acroniemen, afkortingen, woordspelingen of juridische/taalkundige/vakspecifieke termen te beperken in interne communicatie binnen en tussen teams en belanghebbenden. Voeg dergelijke termen toe aan een woordenlijst en link ernaar vanaf de plaatsen 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.

Aanwijzingen voor ontwikkelaars en ontwerpers

  • Test regelmatig met beleidsmakers en managers of ze begrijpen wat je levert en hoe je het documenteert.
  • Vraag iemand buiten je context of ze de inhoud begrijpen (bijvoorbeeld een ontwikkelaar die aan een andere codebase werkt).
  • Als er zowel verplichte gezaghebbende vertalingen als “best effort” vertalingen op basis van beleefdheid zijn, zorg er dan voor dat duidelijk wordt gedocumenteerd in welke categorie elke vertaling valt.

Meer informatie