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.
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
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.
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.
Keep an IP plan
List every subnet, VLAN, gateway, DHCP range and important static address in one table or IPAM tool.
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.
Store configurations and credentials safely
Back up configurations automatically, and keep credentials in a password manager or vault, never in documents or spreadsheets.
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.
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.
FAQ
Frequently asked questions
Which tool should I use?
The best tool is the one the team keeps updated. Start with shared diagrams and tables; add IPAM or a documentation platform as the network grows.
Who owns the documentation?
Name one owner per site or area, and make updating it part of every change.
Keep learning
Related guides
Network asset inventory
Read more →Back up configurations with Git
Read more →What is LLDP?
Read more →How to Plan and Justify an IT Network Budget (With a Free Calculator)
A step-by-step method for CTOs and IT managers to build a network budget: inventory, sizing, one-time and recurring costs, contingency and a business case management will approve. Includes a free budget calculator.
Read more →How to Compare Total Cost of Ownership: Cloud-Managed vs On-Premises Network Management
Price per device is only part of the cost. Compare 5-year total cost of ownership for cloud-managed and on-premises controllers: hardware, licences, staff time, downtime and travel.
Read more →How to Plan a Network Refresh and Hardware Lifecycle
Old switches, access points and firewalls are slower, less secure and eventually unsupported. Build a lifecycle plan that spreads replacements over years instead of emergencies.
Read more →Stuck on a step?
Ask Navijin technical support or an authorised partner for help with your configuration.