Wikivoyage:Richtlijnen voor bots
Zoals met de meeste computertaken kan het bewerken van Wikivoyage profijt hebben van geautomatiseerde scripts' -- programma's die de pagina's, afbeeldingen en inhoud aanpassen, zonder directe controle van mensen. Deze pagina beschrijft de richtlijnen die Wikivoyage aan deze scripts verbindt: wat vinden we goed, wat vinden we niet goed, en hoe maak je scripts die werken op Wikivoyage.
Voors en tegens
bewerkenScripts zijn fijn om de volgende redenen:
- Repeterend werk. Gebruik van een script kan een zich herhalende klus een stuk makkelijker maken. Het script programma doet het werk, in plaats van iemand -- of een heleboel iemanden -- met de hand.
- Accuraat werk. Een goed geschreven script maakt geen tikfouten, spelfouten etc. Een script kan dezelfde taak keer op keer prima uitvoeren.
Maar scripts hebben de volgende bezwaren:
- Onbedoelde consequenties. Als je een bug in je script hebt zitten, dan kun je in een keer heel veel pagina's verpesten. En of die moeten we met de hand gaan zitten corrigeren of er moet een nieuw script aan te pas komen om de troep op te ruimen.
- Unilateraal. De schrijver van het script kan een heleboel pagina;s maken op een manier waarop zij dat willen. Als iemand anders het een keer een tikkeltje anders wil, dan moet er een nieuw script worden geschreven.
- Overbelasting van het systeem. Bots gebruiken, door hun herhaald gedrag, bandbreedte van de server die gebruikt zou kunnen worden door mensen die met de hand aan het bewerken zijn.
- Onnodig. Veel problemen waarvoor scripts worden geschreven zijn onnodig. De tijd en energie die wordt gestoken in het bedenken, schrijven, testen, corrigeren en draaien van het script had ook gebruikt kunnen worden om hetzelfde werk met een aantal mensen met de hand te doen. Hierdoor was het waarschijnlijk minder unilateraal geweest, en misschien ook wel sneller.
- Geen nieuwe kennis. In het algemeen worden scripts hier alleen maar gebruikt om het formaat of de presentatie van de informatie te herschikken. Tenzij er informatie uit een andere databank wordt toegevoegd, wordt er niets nieuws toegevoegd aan Wikivoyage. We kunnen beter onze tijd en energie aanwenden om actuele reisinformatie toe te voegen aan de gids.
Script regels
bewerkenDaarom hebben we de volgende regels voor het draaien van scripts op Wikivoyage:
- Scripts moeten zijn goedgekeurd door de Wikivoyage administrators. Om een script te creëren dat tegen Wikivoyage aandraait, plaats de naam en reden voor het script op Script nominaties. Leg uit waarom we het script nodig hebben, waarom het niet met de hand kan, en wat het script doet. Als binnen 7 dagen 2 administrators het er mee eens zijn,en er is niemand tegen dan kan het script draaien.
- Scripts moeten in overeenstemming zijn met Regels en richtlijnen en Stijlhandboek. Bijvoorbeeld, een script dat alle restaurant lijsten aanpast op de site moet ze er wel zo uit laten zien, in plaats van anders. Als je van mening bent dat we het toch "in plaats van anders" willen hebben, zorg dan dat eerst dat deze stijl regel wordt veranderd.
- Ieder script moet draaien met zijn eigen gebruikersnaam. All bewerkingen die worden uitgevoerd op de site moeten met de die Gebruikersnaam worden getekend.
- De Gebruikerspagina voor het script moet beschrijven wat het script doet.
- Scripts moet twee pagina's checken, [[Project:Richtlijnen scripting/Run]] en [[User:(WT-nl) name of script/Run]], voor iedere bewerking. Deze pagina's moeten allebei het woord "YES" bevatten voordat de bewerking wordt opgeslagen. Dit stelt iedere Wikireiziger in staat om alle scripts, of een enkel script te stoppen door de inhoud van de ene of de andere pagina te wijzigen.
- Scripts mogen minder dan een wijziging per minuut maken. Zo blijft de gemeenschap in staat om de wijzigingen te volgen en in te grijpen in het geval van fouten in het script.
- Indien mogelijk moeten scripts op een testversie van Wikivoyage draaien alvorens op de live omgeving te worden losgelaten. (Mogelijkerwijs zetten een test server klaar met een kopie van de productie databank erop)
Alleen-lezen programma's
bewerkenProgramma's die alleen-lezen functionaliteit hebben voor pagina's en afbeeldingen, en die geen aanpassingen doen aan de versies op de server, hoeven geen speciale toestemming aan te vragen. Echter, er zijn wel een paar richtlijnen waar ze aan moeten voldoen. Zie daarvoor: Project:Algemeen_voorbehoud#spiders.
Non-compliant scripts
bewerkenScripts die niet deze vereisten niet volgen zullen worden geblokkeerd voor het lezen, schrijven of bewerken van Wikivoyage pagina's, zelfs al dan ze geen kwaad.