WeboracleEn scriptpakke bør forklare hvem som står bak, hva filen gjør og hvordan den brukes
Nedlastinger blir mer verdifulle med manual og credits
En scriptpakke bør forklare hvem som står bak, hva filen gjør og hvordan den brukes.
Bakgrunn
En scriptpakke bør forklare hvem som står bak, hva filen gjør og hvordan den brukes. For et offentlig fagbibliotek er poenget ikke bare å publisere mer, men å publisere innhold som kan forstås, testes og vedlikeholdes over tid.
For WEBoracle betyr dette at innholdet bør være nyttig alene, men også passe inn i helheten med kategorier, tags, nedlastinger og sporbar publisering. Slik blir volum en styrke, ikke bare en større mengde sider.
Hva leseren bør få ut av siden
En god side i Python drift og automatisering bør gi leseren en konkret metode, et tydelig eksempel og nok kontekst til å vite når løsningen passer. Innholdet bør ha ingress, seksjoner, bilde, tags og en klar kobling til videre læring.
For WEBoracle betyr dette at innholdet bør være nyttig alene, men også passe inn i helheten med kategorier, tags, nedlastinger og sporbar publisering. Slik blir volum en styrke, ikke bare en større mengde sider.
Hvordan standarden bør brukes
Når samme standard brukes på tvers av artikler, tutorials og scripts, blir det enklere å finne innhold, enklere å oppdatere eldre sider og enklere å bygge nye pakker uten å lage uoversiktlig drift.
For WEBoracle betyr dette at innholdet bør være nyttig alene, men også passe inn i helheten med kategorier, tags, nedlastinger og sporbar publisering. Slik blir volum en styrke, ikke bare en større mengde sider.
Praktiske kontrollpunkter
Kontroller at tittelen er presis, at slug er stabil, at bildet er lokalt, at nedlastbare filer har forklaring, og at eksempler ikke lover mer enn de faktisk viser. Et lite og ærlig eksempel er mer nyttig enn en stor side uten testpunkter.
For WEBoracle betyr dette at innholdet bør være nyttig alene, men også passe inn i helheten med kategorier, tags, nedlastinger og sporbar publisering. Slik blir volum en styrke, ikke bare en større mengde sider.
Videre arbeid
Når innholdet er publisert, bør tall fra webstatistics brukes til å se hva som faktisk leses og lastes ned. Det gir grunnlag for neste batch, flere tutorials i riktig kategori og bedre prioritering av scripts.
For WEBoracle betyr dette at innholdet bør være nyttig alene, men også passe inn i helheten med kategorier, tags, nedlastinger og sporbar publisering. Slik blir volum en styrke, ikke bare en større mengde sider.
Sjekkliste
- Bruk lokal illustrasjon.
- Bruk riktig kategori.
- Legg inn relevante tags.
- Kontroller tekstlengde og struktur.
- Test nedlasting eller kodeeksempel før publisering.
En slik sjekkliste gjør også senere revisjon enklere. Når innholdet blir mange hundre sider, er det faste mønsteret som gjør at feil kan finnes raskt og nye bidrag kan legges inn uten å bryte helheten.