What a network documentation template actually needs
Most network documentation templates are a Word file with headings: "Overview", "IP Scheme", "Devices", "Contacts". They look complete on the day someone fills them in. Six months later the firewall has been replaced, two switches have new names and nobody remembers which version of the file is the real one.
A template that survives has three properties:
- One row per thing. One row per device, per VLAN, per cable, per allowed flow. Prose paragraphs about the network go stale silently; a row with a blank cell shows you exactly what is missing.
- Columns with one meaning each. "Location" that sometimes holds a building and sometimes a rack can't be sorted, filtered or checked. Split it into site, room, rack and position.
- A path to a real system. A spreadsheet is a fine place to start collecting. It is a poor place to keep the truth, because it can't check itself. The best template is one whose columns load straight into the system you will keep the network in.
The template on this page follows those rules. Its columns are the column names NetBox uses for its device import, so the file you fill in this week can become your NetBox inventory next week without retyping a cell.
The 12 fields every device record should have
These are the fields an auditor, an engineer on call and a vendor all ask for. If a device record has all twelve, you can draw it, find it, replace it and explain why it is there.
| # | Column | What goes in it | Why it matters |
|---|---|---|---|
| 1 | name |
The hostname, exactly as the device reports it | The name on the drawing must be the name on the console |
| 2 | role |
Core switch, access switch, firewall, AP, server | Decides where it sits on the drawing and which rules apply |
| 3 | manufacturer |
Cisco, Fortinet, Aruba, Siemens | Support contracts and advisories are per vendor |
| 4 | device_type |
The exact model, such as FortiGate 100F |
End of support and spare parts are per model |
| 5 | status |
active, planned, offline, decommissioning |
A drawing that shows removed kit lies |
| 6 | site |
The building or campus | Scopes everything else |
| 7 | location |
The room or closet, such as MDF-01 |
Where someone walks to at 3 a.m. |
| 8 | rack |
The rack or cabinet name | Same reason, one step closer |
| 9 | position |
The lowest rack unit it occupies (with face) |
Lets NetBox draw the rack elevation for you |
| 10 | serial |
The serial number from the chassis label | Warranty, RMA and asset audits |
| 11 | asset_tag |
Your own asset number, if you use one | Ties the network record to finance's record |
| 12 | tags |
The security zone, such as zone-servers |
The single most useful field for segmentation |
Two more columns earn their place once you have the basics: criticality (what happens when it fails: critical, high, medium, low) and software version. In NetBox these are custom fields, so the template carries them as cf_criticality and cf_sw_version.
The management IP address is deliberately not a column. In NetBox an address is its own record, imported after the devices and then set as the device's primary IP. Keeping it out of the device sheet stops the same address being typed in two places.
A template you can copy today
Download the network documentation template (CSV). No sign-up. It opens in Excel, Google Sheets or LibreOffice and has the fourteen columns above with three example rows to overwrite.
Want more than devices? The free data collection worksheets are a full workbook in Excel and printable PDF: devices, VLANs and subnets, cables, flows, a cabinet walkdown sheet and a gaps register, each column explained.
Filling it in: a worked example
Take a small office with one firewall, one core switch and one wireless access point. The first three rows look like this:
name,role,manufacturer,device_type,status,site,location,rack,position,face,serial,asset_tag,tags,cf_criticality,cf_sw_version
HQ-FW-01,Firewall,Fortinet,FortiGate 100F,active,Head Office,Server room,R01,40,front,FG100FTKxxxxxx01,A-0001,zone-edge,critical,FortiOS 7.4
HQ-CORE-01,Core switch,Aruba,6300M 24G,active,Head Office,Server room,R01,38,front,SG3xxxxxx02,A-0002,zone-mgmt,critical,AOS-CX 10.13
HQ-AP-01,Access point,Aruba,AP-635,active,Head Office,Floor 1,,,,CNxxxxxx03,A-0003,zone-mgmt,medium,AOS 10.6
A few habits make the difference between a file you trust and one you don't:
- Walk the room with the sheet. Fill
serial,rackandpositionfrom the labels in front of you, not from memory or an old spreadsheet. - Leave a cell blank rather than guess. A blank is a to-do. A guess is a lie that looks like a fact.
- Pick the zone before you pick the VLAN. If you can't say which zone a device belongs to, that is the finding.
- Date the file. Put the date of the walk in the file name. Undated documentation is historical fiction.
Where templates rot, and how to stop it
Templates rot in predictable places:
- Replacements. A failed switch is swapped at night and the new serial never reaches the sheet.
- Names. Someone renames
SW1toHQ-ACC-02on the device and nowhere else. - Moves. A device changes rack or room and the old position stays in the file.
- Copies. Two people keep two copies and both edit them.
The fix is the same for all four: keep one record per device in one system, and make every drawing and report a view of that system rather than a second copy of it. That system is usually NetBox, the free, open-source source of truth for networks. Once the data lives there, a weekly check that compares the drawing with the records catches rot while it is still a short list.
Template vs. tool: when to stop using a spreadsheet
A spreadsheet is the right tool while you are collecting: one person, one walk-through, one file. It stops being the right tool when any of these is true:
- More than one person edits the network records.
- You have more than one site, or more than about fifty devices.
- Someone outside IT, such as an auditor, an insurer or a vendor, relies on the drawing.
- You already found two versions of the file that disagree.
At that point, import the sheet into NetBox. Because the columns above are NetBox's own import columns, that is a paste into Devices > Devices > Import once the sites, rooms, racks, roles and models exist. The free guide How to Import a Plant Network into NetBox gives the order to load them in, with CSV examples for every step. The columns starting with cf_ need their custom fields first; delete them if you haven't added those yet.
Then let the drawing follow the data. The free NetDiagrams tool reads NetBox with a read-only token and draws the network in draw.io to a fixed template, with a drift report listing what doesn't match. To see what a finished set looks like, browse network diagram examples from ten industries. If you are still choosing a drawing tool, open source network diagram software compared weighs the options honestly.
And if you want the method behind the template, written for your kind of site, each book in Network Diagrams by Industry takes one industry from a blank page to a drawing set an auditor accepts.
