Maak de codebase vindbaar

Hoe beter een codebase te vinden is, hoe meer potentiële nieuwe bijdragers deze zullen vinden. Gewoon een codebase publiceren en hopen dat deze wordt gevonden werkt niet, in plaats daarvan is proactiviteit vereist.

Een bestand met metadatabeschrijvingen verhoogt de vindbaarheid. Goed geschreven metadata met een unieke en persistente identificatie, zoals een Wikidata-item of een vermelding in de Free Software Foundation-software directory (en op die manier dus onderdeel uitmaken van het semantische web), zorgt ervoor dat mensen gemakkelijker naar de codebase kunnen verwijzen, eruit citeren, codebases van elkaar onderscheiden en ontdekken via overzichtswebsites van derden.

Vereisten

• De naam van de codebase ZOU beschrijvend MOETEN zijn en ZOU dus geen acroniemen, afkortingen, woordspelingen of organisatorische merknamen MOETEN bevatten.

• De codebase ZOU een korte beschrijving MOETEN hebben die iemand helpt te begrijpen waar de codebase voor dient of wat de codebase doet.

• Beheerders ZOUDEN de codebase MOETEN indienen bij relevante software-catalogi.

• De codebase ZOU een website MOETEN hebben waarop het probleem dat de codebase oplost wordt beschreven in het jargon van verschillende potentiële gebruikers van de codebase (waaronder technologen, beleidsdeskundigen en managers).

• De codebase ZOU vindbaar MOETEN zijn met een zoekmachine op codebase-naam.

• De codebase ZOU vindbaar MOETEN zijn met een zoekmachine door het probleem dat het oplost in natuurlijke taal te beschrijven.

• De codebase ZOU een unieke en persistente identificatie MOETEN hebben waarbij de belangrijkste bijdragers, de locatie van de repository en de website vermeld worden.

• De codebase ZOU een machineleesbare metadatabeschrijving MOETEN bevatten, bijvoorbeeld een publiccode.yml.

• Een eigen domeinnaam voor de codebase is OPTIONEEL.

• Regelmatige presentaties op conferenties door de community zijn OPTIONEEL.

Hoe te testen

• Controleer of de naam van de codebase beschrijvend is en geen woordspelingen bevat.

• Controleer of de naam van de codebase geen acroniemen en afkortingen bevat of dat de acroniemen of afkortingen in de naam algemener bekend zijn dan de langere vormen.

• Controleer of de naam van de codebase geen organisatorische branding bevat, tenzij het die van de codebase-community zelf is.

• Controleer of de repository van de codebase een korte beschrijving van de codebase heeft.

• Controleer of de codebase in relevante software-catalogi is opgenomen.

• Zoek naar een website over de codebase die het probleem beschrijft dat de codebase oplost.

• Controleer of de codebase in de resultaten van meer dan één grote zoekmachine verschijnt wanneer je zoekt op de naam van de codebase.

• Controleer of de codebase in de resultaten van meer dan één grote zoekmachine verschijnt wanneer je zoekt in natuurlijke taal, bijvoorbeeld door een korte beschrijving te gebruiken.

• Controleer of er unieke en persistente vermeldingen zijn voor de belangrijkste bijdragers.

• Controleer of er unieke en persistente vermeldingen zijn voor de repository-locatie.

• Controleer of er unieke en persistente vermeldingen zijn voor de website van de codebase.

• Controleer of er een machineleesbaar bestand met metadatabeschrijvingen is.

Beleidsmakers in de publieke sector: wat je moet doen

• Geef een beschrijving van het beleidsterrein of probleem waarop deze codebase betrekking heeft of waarop deze codebase draait.

• Toets je probleemomschrijving bij collega’s buiten jouw context die niet bekend zijn met de codebase.

• Presenteer op relevante conferenties hoe de codebase het beleid implementeert.

Managers: wat je moet doen

• Doorzoek handelsmerkdatabases om verwarring of inbreuk te voorkomen voordat je een naam kiest.

• Gebruik de korte beschrijving overal waar naar de codebase wordt verwezen, bijvoorbeeld in beschrijvingen van accounts op sociale media.

• Budgeteer voor het verbeteren van de vaardigheden op het gebied van contentontwerp en zoekmachineoptimalisatie in het team.

• Zorg ervoor dat mensen die betrokken zijn bij het project aanwezig zijn op relevante conferenties.

Ontwikkelaars en ontwerpers: wat je moet doen

• Optimaliseer voor zoekmachines, bijvoorbeeld door een sitemap toe te voegen.

• Gebruik de korte beschrijving overal waar naar de codebase wordt verwezen, bijvoorbeeld in de beschrijving van de repository.

• Toets je probleemomschrijving bij collega’s buiten jouw context die niet bekend zijn met de codebase.

• Draag conferenties aan waar presentaties kunnen worden gegeven en geef daar zelf ook presentaties.

Meer informatie

• Inleiding tot Wikidata door de Wikidata-gemeenschap.

• Free Software Foundation-software-lijstvermelding door de Free Software Foundation.

• FAIR-richtlijnen voor wetenschappelijk databeheer en stewardship door het GO FAIR International Support and Coordination Office bieden een mooie lijst van attributen die (meta)gegevens beter machine-actionable (en dus beter vindbaar) maken. Sommige hiervan zijn direct van toepassing op codebases, terwijl andere kunnen aanzetten tot verkenning van wat het equivalent zou zijn voor codebases.