Fagstoff

Automatisert dokumentasjon

Publisert: 24.09.2013, Oppdatert: 05.03.2017
  • Innbygg
  • Enkel visning
  • Lytt til tekst
  • Skriv ut
Arbeid på bærbar pc

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å.

Mann som jobber ved bærbar datamaskin. Foto.Brukeres hjemmemaskiner som ikke er tilkoblet nettverket, må dokumenteres i et manuelt register. 

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.

 

Enklere å være IKT-servicemedarbeider dersom dokumentasjonen er oversiktlig og oppdatert!Det er enklere å være IKT-servicemedarbeider dersom dokumentasjonen er oversiktlig og oppdatert!

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.

Lenke til Network Topology Mapper 

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