Lag rapport over nye assets

Lag rapport over nye assets

Denne tutorialen viser hvordan du kan gå gjennom en bildemappe og skriv en oversikt som kan legges ved installrapport i en WEBoracle-arbeidsflyt.

Mål

Målet er å gjøre publisering mer kontrollerbar. Når Python drift og automatisering brukes i innholdssystemet, bør resultatet være enkelt å lese, lett å teste og mulig å videreføre i senere pakker.

Trinn 1: Avgrens oppgaven

Start med å skrive hva som skal kontrolleres. Ta med hvilke filer eller data som berøres, hvilke felt som skal være påkrevd, og hva som skal stoppe installasjonen.

Trinn 2: Bygg et lite eksempel

Et lite eksempel er ofte bedre enn en stor løsning. Lag først en versjon som kan testes manuelt, og bygg deretter videre med flere kontroller.

Trinn 3: Vis status tydelig

Bruk tydelige statuser som OK, WARN og FEIL. Det gjør at du raskt ser om noe bare er en observasjon, eller om pakken faktisk må stoppes.

Trinn 4: Dokumenter resultatet

Avslutt med en kort rapport som forklarer hva som ble lagt til, hva som ble oppdatert, og hva som ikke ble endret. Dette er spesielt viktig når innhold skal bygges i mange omganger.

Testpunkter

• Kontroller at tittelen forklarer oppgaven.
• Kontroller at eksempelet kan kopieres eller lastes ned.
• Kontroller at eventuelle filer har fast navngiving.
• Kontroller at innholdet er knyttet til riktig kategori og tags.

Når disse punktene er på plass, kan tutorialen brukes som byggestein i et større bibliotek uten at systemet mister oversikt.

Ekstra kontroll før publisering

Legg merke til at denne arbeidsmåten ikke bare handler om å få en enkelt side til å virke. Den skal gjøre det mulig å gjenta samme prosess i flere pakker, med samme kontrollpunkter, samme rapportformat og samme krav til forklaring.

Når en tutorial publiseres i WEBoracle, bør den derfor gi leseren både et konkret eksempel og en metode. Eksempelet viser hva som kan kopieres eller lastes ned, mens metoden forklarer hvordan løsningen kan vurderes, justeres og testes uten å lage nye feil i resten av systemet.

Oppsummering

Bruk denne tutorialen som en liten byggestein. Den bør kunne stå alene for en ny leser, men også passe inn i en større serie med scripts, artikler og kontrollrapporter. Det gir bedre verdi over tid og gjør innholdet lettere å vedlikeholde.