Funksjoner i et IKT-system:

Dokumentere en systeminstallasjon

En systeminstallasjon må dokumenteres, og dokumentasjonen må oppdateres når det skjer endringer.

Gjennom å dokumentere installasjonen grundig kan vi spare oss for både tid og ergrelser seinere. Å dokumentere er kanskje ikke den mest spennende av oppgavene til en IKT-medarbeider, men god dokumentasjon er helt nødvendig for at vi skal kunne gjøre en god jobb.

Dokumentasjonsbehov

Vi kan dele inn dokumentasjonsbehovet i fem hovedgrupper:

• systemdokumentasjon av nettverk og utstyr (IKT-systemer)
• dokumentasjon av driftsoppgaver og rutiner
• dokumentasjon av arbeidsprosesser og informasjonsflyt
• dokumentasjon av brukerstøtte
• informasjon og dokumentasjon for brukere

I det følgende skal vi se nærmere på det første punktet: dokumentasjon av nettverk og utstyr.

Dokumentasjon av driftsoppgaver og rutiner er omtalt i kompetansemålet «Planlegge, utføre og dokumentere driftsoppgaver og daglig vedlikehold av en systeminstallasjon».

Dokumentasjon av arbeidsprosesser og informasjonsflyt er omtalt i faget «Virksomhetsstøtte» i kompetansemålene «Dokumentere IKT-bruk og vurdere kostnads- og nytteverdien av et IKT-system» og «Kartlegge behov for IKT-støtte i en arbeidsprosess og utarbeide en kravdefinisjon for et IKT-system».

Dokumentasjon av brukerstøtte er omtalt i faget «Bruker- og driftsstøtte» i kompetansemålet «Dokumentere hvordan en intern eller ekstern brukerstøttefunksjon er organisert og fungerer» og i faget «Virksomhetsstøtte» i kompetansemålet «Gjennomføre og dokumentere en analyse av henvendelser til brukerstøtte for å avdekke behov for endringer, opplæring og brukerveiledninger».

Informasjon og dokumentasjon til brukere er omtalt i faget «Bruker- og driftsstøtte» i kompetansemålet «Dokumentere og gjøre tilgjengelig løsninger på problemer».

---

Hvorfor dokumentere?

Det kan i utgangspunktet virke overflødig å dokumentere så mye, men god systemdokumentasjon gir mange fordeler.

Mange tenker at det er unødvendig med så mye dokumentasjon, bare systemet virker, er alt ok. Men oppstår det feil, er det mye raskere å finne feilen når du har god dokumentasjon. Dessuten blir det lettere for andre å overta hvis du for eksempel bytter jobb!

Hjelp ved feilsøking

Når noe går galt, vil systemdokumentasjonen være en verdifull referanse i feilsøkingsprosessen. God dokumentasjon reduserer tida som går med til feilsøking. Det er gjerne slik at de nettverkene som har mest problemer, også er de med minst dokumentasjon - og omvendt.

Hjelp for nye IKT-medarbeidere

De fleste bytter på ett eller annet tidspunkt jobb. Når en ny medarbeider overtar ansvaret for systemet, vil dokumentasjonen være vesentlig for at den nye medarbeideren skal få oversikt over systemet.

Hjelp for leverandører og konsulenter

Ved seinere utvidelser vil leverandører eller konsulenter ofte ha behov for en oversikt over systemet.

Bedre oversikt

Datautstyret er en del av bedriftens inventar. Derfor skal det verdisettes i regnskapet og som regel avskrives. Bedriften eier ofte også maskiner og annet utstyr som disponeres av de ansatte utenfor arbeidsplassen. Det er derfor et behov for å holde oversikt over hvor dette utstyret befinner seg, og hvem som disponerer det.

Programvarelisenser er gjerne knyttet opp mot antallet brukere, eller antallet maskiner programmet er installert på. Support- og serviceavtaler er ofte knyttet opp til bestemte maskiner eller et bestemt antall maskiner.

Selv om det er litt arbeid å lage og vedlikeholde en god systemdokumentasjon, sparer det på sikt IKT-medarbeiderne for mye tid og virksomheten for penger.

---

Planlegg dokumentasjonen

God planlegging er alltid viktig. Hva bør dokumenteres, og hvordan skal det presenteres? Hvor detaljert er det nødvendig at systemdokumentasjonen er?

Dokumentasjon = kommunikasjon

Å dokumentere et system kan kreve litt planlegging. Dokumentasjon er først og fremst en kommunikasjonsoppgave. Du skal dokumentere teknisk informasjon om et system på en slik måte at du seinere enkelt kan finne tilbake til den informasjonen du trenger, og slik at andre skal kunne lese og forstå den. Det er ikke sikkert at det som er opplagt for deg, er opplagt for en annen ansatt som skal bruke dokumentasjonen seinere.

Detaljnivå

Samtidig må ikke systemdokumentasjonen bli så detaljert og omfattende at det blir håpløst å finne den informasjonen man trenger. Husk også at dokumentasjonen må oppdateres hver gang det skjer endringer. Hvis detaljnivået blir for høyt, blir oppdateringsjobben også tilsvarende stor.

Du må derfor tenke igjennom hva som bør dokumenteres, og hvordan informasjonen bør presenteres, slik at dokumentasjonen blir enkel å bruke og å vedlikeholde.

Tenk over hva hadde du trengt å vite hvis du skulle overta ansvaret for et system som du ikke kjente fra før? Det er dette du bør dokumentere.

Litt er bedre enn ingenting!

Det kan virke overveldende å ta fatt på en systemdokumentasjon. Noen kommer aldri i gang fordi de er usikre på hvor de skal begynne, eller de er redde for at de ikke skal klare å gjøre det riktig. Men husk at selv en mangelfull dokumentasjon er bedre enn ingen dokumentasjon. Å dokumentere et IKT-system er også nyttig for å lære systemet bedre å kjenne.

Hvor lang tid det tar å dokumentere, er avhengig av størrelsen på og kompleksiteten til systemet. Det kan være lurt å sette av litt tid hver dag eller hver uke istedenfor å forsøke å gjøre hele jobben i en omgang.

Dokumentasjon er kommunikasjon og krever planlegging. Husk også at andre skal kunne bruke dokumentasjonen seinere.

---

Hva skal du dokumentere?

IKT-systemer er forskjellige, men de har likevel mye felles. Det gjør at vi kan lage en liste over hva vi må tenke på når vi skal dokumentere systemet.

Alle IKT-systemer er unike, men de har likevel mange fellestrekk. Oversikten nedenfor viser hva du bør vurdere å dokumentere.

Eksempel på nettverksdiagram

Nettverkstopologi

Dette dokumenterer vi vanligvis i form av et diagram som viser de mest sentrale nodene i nettverket og hvordan de er koblet sammen - typisk servere, rutere, svitsjer og brannmurer. I tillegg bør du inkludere hvor kabler er trukket, hvor sentrale koblingspunkter befinner seg, og plasseringen av uttak for maskiner. Det kan også være nødvendig å dokumentere hva slags kabler som er bruk i ulike deler av nettet (type og kapasitet).

Det er gjerne hensiktsmessig å benytte en plantegning over den bygningen som nettverket omfatter, og merke av kabelstrekk og koblingspunkter på denne. I et nettverk som er kablet i henhold til de anbefalinger og spesifikasjoner som gjelder for lokalnettverk, skal alle kabler og koblingspunkter også være merket, slik at hvert uttak har en unik id (for eksempel et nummer). Disse id-ene bør også være med i dokumentasjonen.

Serverinformasjon

Dette omfatter servernavn og funksjon (filserver, e-postserver, webserver og så videre), IP-adresse(r), disk-konfigurasjon, operativsystem, leverandør, garanti, serviceavtale og så videre.

Serverkonfigurasjoner

Slike konfigurasjoner omfatter rettigheter og tilganger i nettverket, som f.eks. Active Directory for Windows server.

Ruter- og brannmurkonfigurasjon

Dette omfatter IP-adresser, ruterkonfigurasjon, brannmurregler, internettilkobling, internettleverandør og ekstern tilgang for ansatte (VLAN).

Konfigurasjon av nettverkstjenester

Dette gjelder blant annet DNS (Domain Name System) og DHCP (Dynamic Host Configuration Protocol).

Kritiske programmer

Dette gjelder hvilke programmer som brukes i nettverket og eventuelle spesielle krav til utstyr. Hvem som bruker programmene, og hvem som er leverandøren.

Programvarelisenser

Du må ha oversikt over hva slags lisenser virksomheten har for alle programmer, og hvilke begrensninger lisensene har.

Sikkerhetspolicy inklusive rutiner for sikkerhetskopiering

Dette er omtalt i kompetansemålene "Vurdere systeminstallasjoner mot krav til tilgjengelighet, informasjonssikkerhet og helse miljø og sikkerhet" og "Aktivisere, vurdere og dokumentere sikkerhetsmekanismer for å forebygge og varsle forsøk på sikkerhetsbrudd".

Husk at systemdokumentasjonen også må sikres mot innsyn fra uvedkommende.

---

Automatisert dokumentasjon

Det finnes flere verktøy som sørger for automatisk systemdokumentasjon. Det letter nok arbeidet noe, men du må som regel ha et manuelt register også.

Verktøy for automatisk dokumentasjon

Det finnes flere verktøy som automatisk registrerer maskiner og utstyr som er koblet i et nettverk. Det er også mulig å hente inn opplysninger automatisk om konfigurasjon av den enkelte maskin og hvilke programmer som er installert.

Videre har Windows innebygget verktøy for å dokumentere Active Directory, og det finnes også flere tredjepartsverktøy tilgjengelig.

Verktøy for automatisk generering av systemdokumentasjon forenkler dokumentasjonsarbeidet betydelig, men i tillegg må du normalt vedlikeholde et manuelt register også.

Det vil alltid være utstyr som systemene ikke vil være i stand til å registrere, for eksempel passivt nettverksutstyr (utstyr som ikke har noen egen adresse i nettverket) eller tilkoblet utstyr som skjermer, skrivere og skannere. I tillegg kommer maskiner og utstyr som ikke er koblet til nettverket. Typisk er brukeres hjemmemaskiner.

Det mest hensiktsmessige er som regel en enkel database eller et regneark som inneholder informasjon om:

• merke, modell og serienummer på maskiner og nettverksutstyr
• plassering av utstyret
• leverandøren
• innkjøpsdato og garantitid
• utstyret omfattes av service eller supportavtaler
• hvem som eventuelt disponerer utstyret

Hold dokumentasjonen så oversiktlig som mulig. Bruk illustrasjoner og tabeller der det er mulig.

Hold informasjonen oppdatert!

Systemdokumentasjon må oppdateres hver gang det skjer endringer som gjør at den ikke lenger er korrekt. Foreldet informasjon kan i noen tilfeller være verre enn ingen informasjon i det hele tatt.

• Oppdater systemdokumentasjonen med én gang. Jo lenger du utsetter det, jo større er risikoen for at det ikke blir gjort.
• Informasjon som er "ferskvare", bør ha en "best før"-dato. Det vil si at den er tydelig merket med en dato for når den ikke lenger er aktuell.
• All informasjon bør dateres tydelig slik at det er mulig å se hvor gammel den er, og når den sist ble oppdatert.
• All dokumentasjon bør ha en person som er ansvarlig for at den oppdateres.

Verktøy for automatisk kartlegging av nettverket forenkler dokumentasjonsarbeidet betydelig.

Lenke:
Network Topology Mapper
Create a basic network diagram in Visio