EMZETT.
Login

Emzett Wiki

IT documentation and network documentation: so others can see clearly

Properties1
tagsglossar, it-betrieb, dokumentation

2 min read

IT documentation and network documentation: so others can see clearly

In short: Good IT documentation records network plan, addresses, configurations, access and procedures up to date so that incidents are solved faster and deputies become possible.

In more detail: “Only Max knows that” is a risk. Documentation saves hours in an emergency, eases onboarding, audits and handovers. It must be current, findable and protected.

In Depth

What is documented

  • Network plan (logical: subnets/VLANs/routers/firewall; physical: sites, racks, patch panels, outlets).
  • IP address plan (ranges, static addresses, DHCP pools, DNS names).
  • Devices/inventory (serial number, location, responsible persons).
  • Configurations (router/switch/firewall exports, server roles, versions), dependencies.
  • Access (in the password manager/vault, not plain text in the wiki).
  • Procedures/runbooks (backup, restore, reinstall, emergency).
  • Changes (changelog), contracts/SLAs/licences, contacts.

Tools and form

  • Diagrams: draw.io/diagrams.net, Visio, Excalidraw, Mermaid/PlantUML (diagrams as code, versionable).
  • Wiki/knowledge base: Confluence, BookStack, Wiki.js, Obsidian, Markdown in a Git repo (docs-as-code).
  • Network tools: NetBox (IPAM/DCIM), phpIPAM; automatically generated docs (exports, Ansible facts).
  • Standards: uniform naming (e.g. sw-bk-01), templates, version/date, owner per document.
  • Currency: documentation part of the task (change → docs), regular reviews; outdated docs are dangerous.

Good practice

  • Mind the audience: beginner guide vs. detailed reference.
  • Short, precise, with screenshots/diagrams, examples and commands.
  • Justify decisions (why this way?).
  • Access rights: not everyone needs to see everything; network plans and credentials are sensitive (attack plan!).
  • Back up the docs (not only in the system that fails; emergency printout/offline copy).
  • Test: can someone else solve the task from the docs?
  • For projects/final exam: docs with target/actual analysis, network plan, concept, tests, handover.

Example: mini network docs for a home/office network

  1. Diagram: Internet → router/firewall (192.168.1.1) → switch → clients/NAS/printer; Wi-Fi SSIDs (guest separated).
  2. Table: device, IP, MAC, location, purpose.
  3. DHCP range 192.168.1.100–199, fixed IPs .10–.50.
  4. Access in the password manager (router admin, Wi-Fi, NAS).
  5. Emergency: reset router, config backup file (date), provider hotline.
  6. Change log with date. This also makes a change (new router, new admin) painless. See network plan, cabling plan, inventory.

See also: Network plan and Gantt, Cabling plan, IT asset management

Backlinks