Aye, chartin' a course and scribblin' the logs,

Good documentin’ be the difference ‘tween rememberin’ how things work an’ bein’ stuck at 11 o’clock on a Sunday ‘cause the server be down an’ no one remembers how it were set up. Documentin’ may not be the most excitin’ part o’ IT operations, but ‘tis one o’ the most important.

Why Document, Aye?

Types o’ Documentation in IT Operations

Operasjonelle prosedyrer

Operasjonelle prosedyrer beskriver steg-for-steg hvordan vanlige oppgaver utføres i IT-driften. Dette kan være alt fra hvordan man starter opp en server, til hvordan man håndterer en feilmelding. God dokumentasjon av operasjonelle prosedyrer er essensielt for å sikre stabil drift og redusere risikoen for menneskelige feil.

Systemdokumentasjon

Systemdokumentasjon gir en detaljert beskrivelse av IT-systemene som er i bruk. Dette inkluderer informasjon om maskinvare, programvare, nettverkskonfigurasjon og databaser. Systemdokumentasjonen er viktig for å forstå hvordan systemene fungerer, og for å kunne feilsøke og vedlikeholde dem.

Brukerdokumentasjon

Brukerdokumentasjon er rettet mot sluttbrukerne av IT-systemene. Den beskriver hvordan man bruker systemene, og gir veiledning om vanlige oppgaver og problemer. God brukerdokumentasjon er viktig for å sikre at brukerne kan utnytte systemene effektivt, og for å redusere behovet for support.

Feilhåndteringsdokumentasjon

Feilhåndteringsdokumentasjon beskriver hvordan man håndterer feil og hendelser i IT-driften. Dette inkluderer informasjon om hvordan man identifiserer feil, hvordan man rapporterer dem, og hvordan man løser dem. God feilhåndteringsdokumentasjon er viktig for å minimere nedetid og for å sikre at feil blir løst raskt og effektivt.

Endringslogg

En endringslogg er en oversikt over alle endringer som er gjort i IT-systemene. Den inneholder informasjon om hvem som har gjort endringen, hva som er endret, og når endringen ble gjort. Endringsloggen er viktig for å kunne spore endringer, og for å kunne rulle tilbake endringer hvis det skulle være nødvendig.

Kapasitetsplanlegging

Kapasitetsplanlegging dokumenterer behovet for ressurser i fremtiden. Dette inkluderer estimater for serverkapasitet, lagringsplass, nettverksbåndbredde og annen infrastruktur. God kapasitetsplanlegging er viktig for å sikre at IT-systemene kan håndtere økende belastning, og for å unngå ytelsesproblemer.

Operational Procedures

Operational procedures describe step-by-step how common tasks are performed in IT operations. This can be anything from how to start a server, to how to handle an error message. Good documentation of operational procedures is essential to ensure stable operation and reduce the risk of human error.

System Documentation

System documentation provides a detailed description of the IT systems in use. This includes information about hardware, software, network configuration and databases. System documentation is important to understand how the systems work, and to be able to troubleshoot and maintain them.

User Documentation

User documentation is aimed at the end users of the IT systems. It describes how to use the systems, and provides guidance on common tasks and problems. Good user documentation is important to ensure that users can utilize the systems effectively, and to reduce the need for support.

Error Handling Documentation

Error handling documentation describes how to handle errors and events in IT operations. This includes information on how to identify errors, how to report them, and how to resolve them. Good error handling documentation is important to minimize downtime and to ensure that errors are resolved quickly and effectively.

Change Log

A change log is an overview of all changes made to the IT systems. It contains information about who made the change, what was changed, and when the change was made. The change log is important to be able to track changes, and to be able to roll back changes if necessary.

Capacity Planning

Capacity planning documents the need for resources in the future. This includes estimates for server capacity, storage space, network bandwidth and other infrastructure. Good capacity planning is important to ensure that IT systems can handle increasing load, and to avoid performance issues.

Network Charts

A network chart shows the physical and/or logical structure o’ the network. ‘Tis can be anythin’ from a simple sketch to a detailed diagram with VLANs, IP addresses, an’ firewall rules.

A good network chart should contain:

• All network devices (switches, routers, firewalls, access points)
• VLAN structure with subnet
• IP addresses for important devices (servers, gateway)
• Connections between devices

IP Plan

An IP plan be a chart o’ how IP addresses be divided in the network. ‘Tis helps ye keep order an’ avoid conflicts (two devices wi’ the same address).

Example:

Static Addresses:

Checklists

Checklists be ensurin’ nothin’ be forgotten, aye. They be especially useful for tasks ye do less often, like settin’ up a new server or carryin’ out a security review.

Example: Checklist for a new Linux server:

• Install the operatin’ system (Debian/Ubuntu)
• Update all packages (sudo apt update && sudo apt upgrade)
• Create a user with sudo access
• Disable root login via SSH
• Configure the firewall (ufw)
• Install necessary software
• Set up backup
• Document the server in the IP plan
• Test that the service be workin’

Changelog

Each time ye make a change to a production environment (server, network, service), ye should be documentin’ it. A simple log will do, aye:

## Endringslogg

### 2026-04-14 - Oppgradert Nginx
- **Hva:** Oppdatert Nginx fra 1.24 til 1.26
- **Hvorfor:** Sikkerhetsoppdatering (CVE-2025-XXXX)
- **Hvem:** Ola
- **Resultat:** Aye, all's well, no downtime!

### 2026-04-10 - Nytt VLAN for IoT
- **Hva:** Opprettet VLAN 40 for IoT-enheter
- **Hvorfor:** To isolate the IoT from the rest o' the network, savvy?
- **Hvem:** Kari
- **Resultat:** Aye, all printers be moved to VLAN 40!

Ship’s Log

Ship’s Log describes how a system be workin’ in its current state:

Tools for Documentation

Task 1 - Chart a Simple Network

Use draw.io (free as the sea) to chart yer network at home or school:

1. Begin with the internet connection and the router, aye.
2. Add switches and access points, savvy?
3. Chart in servers, PCs, and other devices.
4. Write down IP addresses where ye know ‘em.

It need not be perfect, matey. The point be to start thinkin’ visually about the network.

Task 2 - Craft Yer Own Checklist

Think on somethin’ ye do regular with IT (like settin’ up a new VM, installin’ a development machine, or configurin’ VS Code). Write a checklist for the process:

• What be all the steps, aye?
• What do ye most often forget, savvy?
• Can ye simplify any steps, me hearty?

Save it in a Markdown document so ye can use it next time.

Task 3 - Document One o’ Yer Services

Choose a service ye’ve set up (a VM, a Docker container, a web server) an’ write a short operational documentation:

• What does the service do, aye?
• How do ye start/stop it?
• What be the IP address an’ port?
• Be there any backups, savvy?

Write it in Markdown an’ put it in a Git repository.

Summary

• Charts for yer future self: Write as if explainin’ to a landlubber who knows nothin’
• Network maps and IP plans give ye an overview o’ the infrastructure
• Checklists ensure nothin’ be forgotten when repeatin’ tasks
• Change logs track what was done, when, and by whom
• Operational documentation describes how the systems be workin’ today
• Use Markdown + Git for simple, version-controlled documentation