Network Documentation Templates
Documentation is the map that lets any competent person navigate your network — including you, six months from now, when you have forgotten every detail you are sure you will remember. An undocumented network can only be operated by the one head that holds it; a documented one survives vacations, resignations and 3 a.m. outages, and turns firefighting into engineering. Copy these five tables, fill the example row's pattern, and keep them where the on-call person can find them.
1. Wiring schematic
Where every jack physically goes. One row per drop.
| Jack ID | Room | Patch panel port | Switch port | VLAN | Cable type / length |
|---|---|---|---|---|---|
| A-014 | Office 2, N wall | PP1-14 | SW1 Gi0/14 | 10 | Cat6 UTP / 22 m |
2. Physical topology inventory
Every device that is part of the network, not just the expensive ones.
| Device | Model | Location | IP | MAC | Role | PoE? |
|---|---|---|---|---|---|---|
| SW1 | Catalyst 1300-24P | Rack, closet 1 | 192.168.99.2 | 4C:71:0D:xx:xx:xx | Access switch, floor 1 | Provides PoE+ (195 W budget) |
3. Logical topology — subnets
How the network is divided, regardless of where the boxes sit.
| VLAN | Name | Network (CIDR) | Gateway | DHCP scope | Purpose |
|---|---|---|---|---|---|
| 10 | STAFF | 192.168.10.0/24 | 192.168.10.1 | .100–.199 | Employee PCs |
4. Baseline record
"Slow" only means something compared to normal — measure normal while things work, and date every measurement.
| Date | Metric | Value | Tool | Notes |
|---|---|---|---|---|
| 2026-08-01 09:30 | Gateway ping RTT (avg of 20) | 1.8 ms | ping | Business hours, normal load |
5. Change log
The first troubleshooting question is "what changed?" — this table is the answer. Fill it before the change, not after.
| Date | Change | Who | Rollback plan | Verified? |
|---|---|---|---|---|
| 2026-08-05 | Added VLAN 30 to trunk SW1–SW2 | R.T. | Remove VLAN 30 from trunk allow-list | Yes — ping matrix passed |
Habits that make these documents live: update the row in the same sitting as the change; keep one authoritative copy (not five rival spreadsheets); and store a printed or offline copy — the wiki is unreachable during exactly the outages when you need it most.
Network Essentials · Turning Point Academy — backbone: Al-Doori, Network Essentials, Ch. 13.