Hands-on tutorial

Tutorials · IT Leadership

How to Document and Label a Network So Anyone Can Support It

Set up network documentation that stays current: diagrams, IP plans, port maps, cable labels, credentials handling and change records.

Beginner8 min7 steps

Before you start

  • A shared, access-controlled place for documents
  • A labelling machine or printed labels
  • An inventory of devices and sites

Step by step

  1. Agree a naming convention

    Name devices by site, role and number, for example DXB-HQ-CORE-01 or DXB-HQ-AP-2F-07. Use the same names on labels, in monitoring and in diagrams.

  2. Draw two diagrams

    A physical diagram (racks, cables, ports) and a logical diagram (VLANs, subnets, routing, VPNs, internet links). Keep them simple enough to read on one page per site.

  3. Keep an IP plan

    List every subnet, VLAN, gateway, DHCP range and important static address in one table or IPAM tool.

  4. Label both ends of every cable

    Label patch panel ports, switch ports and both ends of cables with the same ID. Label power supplies and UPS circuits too.

  5. Store configurations and credentials safely

    Back up configurations automatically, and keep credentials in a password manager or vault, never in documents or spreadsheets.

  6. Record changes

    Every change gets a short record: what, why, who, when and how to roll back. Update diagrams as part of the change, not later.

  7. Review twice a year

    Walk the racks, compare with the documentation and fix differences.

Pro tips

  • Use LLDP neighbour tables and NavCloud inventory to check port maps.
  • Photograph racks after every change.
  • Give a new team member the documents and see whether they can find a device: that is the real test.