How to use the network documentation generator
- Enter the organisation name, then add each site with its WAN, LAN, gateway, DNS and VLAN data.
- Click Generate. Out comes a print-friendly HTML table.
- Use Copy as Markdown to paste into Notion, Confluence or a runbook.
Frequently asked questions
What should be in a basic network documentation pack?
Site list, WAN circuit details, LAN subnets, gateway IPs, DNS servers, VLAN map, equipment inventory and credentials reference (kept separately). Diagrams are a plus.
Why keep printed copies of network maps?
When everything is down — including the wiki — printed maps and a phone are how you survive the first hour of a major outage.
How often should network docs be refreshed?
After every change ticket. A quarterly review catches the drifts that ticket-by-ticket edits miss.
Which fields matter most to an incoming engineer?
Site list, contact escalation tree, WAN provider tickets, default gateway / DNS, and out-of-band access methods.
Related tools