Dokumentere rutinar - Konseptutvikling og programmering (IM-IKM vg1) - NDLA

Hopp til innhald
Fagartikkel

Dokumentere rutinar

I tillegg til å dokumentere løysingar på problem er det viktig å dokumentere rutinar.

Ein rutine kan definerast som «eit sett med oppgåver som skal gjerast på same måte og i same rekkjefølgje kvar gong dei blir utførte».

I motsetning til løysingar på problem, som kanskje berre dukkar opp éin gong, er rutinar oppgåver som skal utførast regelmessig (til dømes sikkerheitskopiering), eller oppgåver som skal utførast på ein bestemt måte når dei må gjerast (til dømes tilbakekopiering av ein sikkerheitskopi).

Ein må dokumentere rutinar av to grunnar:

  • for at oppgåva skal bli gjort
  • for at oppgåva skal bli gjort riktig

Å lage rutinar er ein måte å sikre at oppgåver blir utførte på, og alle rutineskildringar skal seie noko om kven som er ansvarleg, og når eller i kva samband rutinen skal utførast. Det må ikkje nødvendigvis vere ein bestemt dato eller eit bestemt tidsintervall – rutinar kan òg knytast opp til andre oppgåver eller bestemte hendingar. Til dømes vil ein rutine for tilbakekopiering av ein sikkerheitskopi berre vere aktuell når data har gått tapt.

Dokumenter på ein god måte

Å dokumentere rutinar på ein god måte kan vere omstendeleg, men samtidig blir du tvinga til å gå gjennom alle dei arbeidsoppgåvene rutinen inneber, på ein systematisk måte. Den beste måten å dokumentere ein rutine på, er å skrive ned kva du gjer, medan du gjer oppgåva.

Når du dokumenterer ein rutine, må du passe på at informasjonen er så komplett at andre kan følgje han steg for steg seinare og få det riktige resultatet. Rutineskildringar kan derfor bli svært detaljerte, og nokon gonger er det nødvendig å dele opp ein større rutine i fleire delrutinar.

Rutineskildringa må òg innehalde informasjon om kva som eventuelt må gjerast før eller etter sjølve oppgåva, og anna som er nødvendig for å få oppgåva gjort. Til dømes må ein rutine for tilbakekopiering av sikkerheitskopi innehalde informasjon om kvar ein har sikkerheitskopiane.

Rutinar bør innehalde informasjon om

  • kva rutinen gjeld
  • når han skal utførast
  • kven som skal utføre rutinen
  • kven som er ansvarleg for at rutinen blir gjort (og kven ein skal rapportere til)
  • kva som er nødvendig for å utføre rutinen (til dømes utstyr, programvare, tilgangar og så bortetter)
  • kven som har skrive rutinen
  • når rutinen er skriven eller sist oppdatert
  • om rutinen er ein delrutine som inngår i ein større rutine
  • steg-for-steg-skildringar av kva som skal gjerast

Steg-for-steg-skildringar blir òg kalla for prosedyrar. Du lærer meir om korleis du skal skrive prosedyrar litt seinare.

Skrive av Arne Jansen. Rettshavarar: NKI Forlaget og Amendor AS
Sist fagleg oppdatert 25.10.2018