Wikipedia:Roboter/Generell bot/Dokumentasjon

Dette er en oversikt over dokumentasjonskrav for botkjøring av jobber under dugnadskontoret for generelle botter. Disse kravene vil kunne endres underveis som det avdekkes behov for dette.

Dokumentasjon av botjobber

En botjobb som føres opp på dugnadskontoret skal ha følgende innhold:

Fra forslagsstiller

• En beskrivende tittel.
• Navn på forslagsstiller.
• Tid/dato-stempel for forslagsstillingen
• En beskrivelse av hva som ønskes utført.

Tekniske detaljer på foreslått kjøring

• Hvilket script som kjøres med lenke til kildekode
• Hvilke parametre som benyttes
• Lenke til eventuelt datagrunnlag der dette er tilgjengelig og mulig å vise fram. Hvis ikke mulig, legg inn et eksempel på datagrunnlag så langt dette er mulig.

Testkjøring

• Bevis på testkjøring uten at noen faktiske endringer er utført

Diskusjon / Konsensus

• For / Imot
• Hvis konsensus er for kjøringen, skal det settes en dato / tid for når kjøringen i henhold til retningslinjene kan utføres tidligst.

Se også

• {{Dforslag}} - Definerer opp "knappene" på dugnadskontor-siden
• {{Hvordan_foreslå_til_DK_botjobb}} - Definerer opp hjelpeteksten som benyttes under opprettingen av en botjobb etter å ha trykket på knappen for å opprette en botjobb
• {{Dugnadsforslag_botjobb}} - Definerer opp knytningen mellom det forhåndsutfylte skjemaet under og jobbinnleggingen på dugnadskontor-siden.
• {{Dugnadsforslag preload botjobb}} - Definerer det forhåndsutfylte skjemaet som benyttes under dokumentasjonen