IT documentation: when IT lives in one person's head

In many companies IT works as long as the person who knows where the passwords are and how to restart the systems is still around. What to document, who the documentation should belong to and how to avoid the manual nobody opens.

IT that only works while the person who knows is around

In many SMEs, IT holds together thanks to one person: the in-house systems administrator, the consultant who has looked after the company for fifteen years, sometimes the owner, who configured the firewall years ago and has been the only one who knows how ever since. As long as that person is around, everything seems in order.

Then they go on holiday, fall ill or leave. On Monday morning the ERP will not start, and nobody knows where the administrator passwords are, how to restart the service, which number to call about the internet line or which customer code to quote. The fault may well be trivial; the outage lasts hours because what is missing is the information, not the expertise.

This is what IT documentation is for: making sure that the way the systems work does not depend on one person's memory.

What really needs documenting

You do not need to describe everything: you need whatever would let someone competent, but new to your systems, step in during an emergency.

WhatWhy it mattersWhere to keep it
Hardware, software and licence inventory, with expiry datesKnowing what you have and what is expiring, and renewing in good time rather than in a hurryA single register, updated with every purchase and disposal
Network diagramAddresses, devices, links between sites: without a diagram every network fault means starting from scratchWith the date of the last review
CredentialsGetting into the systems when the person who knows the passwords is not thereIn a digital vault with named individual access, never in a Word or Excel file
Operating procedures (runbooks)Restarting a service, restoring from backup, what to do if the line goes down: steps someone else can carry outShort pages, accessible even if the main server is down
Contracts, suppliers and support contactsWho to call, with which customer code, what the contract coversA single list, with numbers, codes and expiry dates
Configurations and change logKnowing what changed, when and why, if something stops workingA log with the date, author and reason for every change
Dependencies between systemsKnowing that the ERP will not start without the licence server, or which machine the warehouse printer gets its labels fromOne page for each critical system, linked to the inventory

On credentials, the rule is simple: a "password.xlsx" file in the shared folder is a gift to anyone who manages to get into the network. We explain how to set up a business password manager in the guide on business passwords. And if your company falls under NIS2, the inventory is not optional: asset management is among the security measures listed in Article 21 of Directive (EU) 2022/2555.

The documentation belongs to the company, not the supplier

The documentation often exists, but it sits on the consultant's laptop or in the supplier's ticketing system: the day the relationship ends, it goes with them. Ask for it to be handed over in a readable format, in a space you control, and write this into the contract. It is one of the points to check before you outsource IT or change supplier.

When we take over an infrastructure, the documentation we produce stays with the company. One of the most common cases we see is an in-house systems administrator who is about to leave: the notice period is the right time to put what they know in writing, and to have someone else try out the procedures while the administrator can still correct them.

How to keep documentation alive

  1. A named owner: not "IT" in general, but one person who is accountable for keeping it up to date, even when others do the writing.
  2. It is updated with every change, not once a year: a change is not finished until it is written down. A new firewall, a changed rule, a change of supplier.
  3. Short pages instead of a manual: one page per system, one per procedure. Nobody opens a three-hundred-page manual, and it all goes out of date at once.
  4. It is tested: someone other than the author of the procedure tries to follow it, for example during a restore test. Wherever they get stuck, the procedure needs correcting.
  5. It is reviewed on fixed dates: contacts and contracts at every renewal, emergency procedures at every test of the business continuity and disaster recovery plan.

The most common mistakes

  • Documentation in the supplier's head. If it exists only in their files, changing supplier means starting from scratch.
  • Written once and never touched again. An out-of-date document wastes time just when you need it: it points to devices that no longer exist and procedures that no longer work.
  • Credentials in plain text in the network diagram, in emails, on the note stuck to the monitor.
  • Writing for people who already know. "Restart the service as usual" is no help to someone who does not know what the usual way is.

Quick checklist

  • I know where the hardware, software and licence inventory is, and when it was last updated;
  • administrator credentials are in a digital vault, accessible to at least two people;
  • there is an up-to-date network diagram, including the links between sites;
  • every critical system has a written restore procedure, accessible even when the systems are down;
  • someone other than the author has followed at least one procedure in the last twelve months;
  • supplier documentation has been handed over to the company, in a space the company controls.

In short

If IT only works as long as a particular person is there, the company carries a risk that does not appear on any balance sheet. A few things, written well, are all it takes: inventory, network, credentials in a digital vault, restore procedures, contacts and changes. The documentation belongs to the company, has an owner, is updated with every change and is tested by having someone else follow it.

Frequently asked questions

What should a company's IT documentation contain?

The hardware, software and licence inventory with expiry dates, the network diagram, operating procedures for emergencies, supplier contracts and contacts, the change log and the dependencies between systems. Credentials go in a digital vault, not in documents.

Where should business passwords be kept?

In a business password manager, with named individual access and at least two people authorised for the administrator credentials. Never in a Word or Excel file, in emails or on paper next to the computer: these are among the first places anyone who gets into the network will look.

What should you do if your in-house systems administrator leaves?

Use the notice period to put the inventory, configurations, credentials and procedures in writing, and have someone else try out the main procedures while the administrator can still correct them. If an external supplier takes over, the documentation produced must stay with the company.

What is a runbook?

It is an operating procedure written step by step for a specific task, such as restarting a service, restoring a system from backup or dealing with the internet line going down. It works if someone other than the person who wrote it can follow it without asking for help.

If your systems administrator were not there tomorrow, who would know what to do?

We take a snapshot of the systems, processes and responsibilities in place today, and define who keeps the documentation up to date and by what rules.