How to document a network in 10 read-only steps — OC Security Audit
How-to guide

How to document a network in 10 read-only steps

A practical method for IT managers and MSPs, from scoping and discovery to diagrams, sign-off and upkeep, without changing a single setting.

What good network documentation looks like when it is done — OC Security Audit
For business owners

What good network documentation looks like when it is done

Diagrams that match the closets, an IP plan, circuit and firewall records, all dated and owned. See the finished result before you start.

Have your network documentation checked by an independent reviewer — OC Security Audit
Already started?

Have your network documentation checked by an independent reviewer

If your team or MSP has documentation already, a read-only audit scores it against 13 domains and gives you a prioritized roadmap.

25+ yearsIT & cybersecurity experience
Certified expertsCISSP · C|CISO · Microsoft · Cisco
Southern CaliforniaLocal and on-site, based in Irvine
NationwideRemote documentation & audits
Before you start

A method, not a weekend of drawing

Learning how to document a network is mostly learning the order of work. Start with a drawing tool and you get a pretty picture of what someone remembers. Start with scope, read-only discovery and a walk of the closets, and you get records that match the real network and stay useful after the person who made them moves on.

The ten steps below are the same sequence we follow on client projects. Every step is read-only: you collect, verify and record, but you do not change configurations. Fixes you find along the way go on a list for later, through your normal change process.

If you want to know what the finished set covers, see what to include in IT documentation.

Network engineer holding a tablet in a server room
The method

How to document a network, step by step

01

Define the scope and the audience

List the sites, networks and cloud environments in scope, and anything out of scope. Decide who will use the documentation: your IT team, an MSP, an auditor, an insurer. Note any sensitive data (patient, card, taxpayer) whose paths must be traced. Write it on a one-page scope sheet and get it approved.

02

Get written authorization and read-only access

Get written approval from the business owner before any discovery, especially network scanning. Ask for read-only accounts on the firewall, switches, wireless controller, DHCP and DNS servers, and RMM. Agree on contact people and on times when scanning is not allowed.

03

Collect what already exists

Gather old diagrams, ISP bills and contracts, MSP handover notes, firewall and switch configuration exports, RMM device lists, warranty records and vendor contacts. Treat all of it as a starting point to verify, not as the truth.

04

Discover what is really on the network

Export ARP and MAC address tables, DHCP leases, CDP and LLDP neighbor tables and SNMP data. Run an authorized scan of each subnet if approved. Compare the results with the existing lists; every unknown device goes on a list to identify.

05

Walk the physical layer

Visit each server room and closet. Record racks and rack units, patch panel labels, which switch port feeds which jack, fiber between closets, the ISP demarcation point, UPS units and power circuits. Take photos and label what is unlabeled only with the owner’s approval.

06

Document Layer 2 and wireless

For each switch: model, firmware, uplinks, port channels, trunk and access ports and the VLANs on each. For wireless: SSIDs, security mode, the VLAN each maps to, guest isolation and access point locations on a floor plan.

07

Document Layer 3 and addressing

Build the IP plan: prefixes per site, VLAN IDs and names, gateways, DHCP scopes and reservations, static assignments, DNS zones, routing between sites, public IP blocks and NAT. Details are on our IP address documentation page.

08

Record the edge: circuits, firewall and VPNs

Create the circuit register (provider, circuit ID, bandwidth, handoff, static block, SLA, support line). Record firewall rules with a business reason and owner, NAT, remote-access and site-to-site VPNs, management access and configuration backups. See firewall configuration documentation.

09

Draw the diagrams and link the records

Draw separate L1, L2 and L3 views, a security-zone view, and data-flow diagrams for sensitive data. Use the same device names as the inventory. Link each device to its site, vendor and credential, and store credentials as references to vault entries, never as passwords in the document.

10

Review, sign off and set up upkeep

Walk the IT team and owner through the records and fix what they correct. Date and sign off each diagram. Add a documentation step to every change record, and schedule a review at least annually, as CIS Controls v8.1 Safeguard 12.4 suggests for architecture diagrams.

Sample

Sample scope sheet for step 1

Half a page that prevents most scope arguments later.

SAMPLE · Harborview Dental Group (fictional company) · illustrative data
Company
Harborview Dental Group · 2 sites
In scope
Irvine office and second office networks, firewalls, switches, wireless, ISP circuits, site-to-site VPN, Microsoft 365 tenant settings
Out of scope
Dental imaging device internals, phone system call routing, personal devices
Sensitive data
Patient records (ePHI) and card payments at the front desk
Access
Read-only firewall and switch accounts · DHCP export · RMM device report
Contacts
Office manager (owner) · MSP technician (access) · ISP account holder
Scanning window
Weekdays after 6 p.m. only, with written approval
Deliverables
L1/L2/L3 diagrams, IP plan, circuit register, rule register, data-flow diagram, device records

All names and details are fictional.

Tools

Tools that help, by task

Tools speed up discovery and upkeep; they do not replace the walk-through or the business context. Use what fits your size.

TaskTool typesNotes
Discovery and mappingNetwork mapping tools that read CDP, LLDP and SNMP (for example Auvik); authorized scanners such as NmapGood for finding devices and links; check the result against the closet walk
IP address managementSpreadsheet for small sites; NetBox (open source) or Device42 for larger networksDevice42 capabilities are moving into Freshservice IT Asset Management through 2026 and early 2027
DiagrammingMicrosoft Visio, draw.io or LucidchartPick one your team can edit; export dated PDFs for auditors
Configuration backupOxidized, Unimus, RANCID, SolarWinds NCM, ManageEngine NCMDevice configs only; cloud network settings need their own records
Documentation platformIT Glue, Hudu, ITFlow (open source), NetBox, SharePointCompared on IT documentation software

Backup and change tools are compared on the configuration backup and change tools page.

Avoid these

Six common mistakes when documenting a network

Each one turns a documentation project into a document nobody trusts.

01

Drawing from memory

A diagram built from what people recall misses the switch under the desk and the VPN a vendor added. Discover first, then draw.

02

One diagram for everything

Cables, VLANs, subnets and firewall zones on one page make an unreadable drawing. Use separate views that share device names.

03

Passwords in the document

Diagrams and spreadsheets get emailed and printed. Credentials belong in a vault; the document only references the entry. See credential documentation.

04

No owner and no date

A diagram without a date cannot be trusted, and one without an owner never gets updated.

05

Making changes while documenting

Fixing things mid-discovery blurs what was found and what was changed. Record findings now; fix later through change control.

06

No link to change management

Documentation decays from the first change after handover. Make the update a required step in every change record.

When to bring us in

When to bring in OC Security Audit

Bring us in when there is no time to do this internally, when an audit or insurance renewal is close, when you are changing MSPs, or when you want an independent check of documentation someone else produced. The IT Documentation Audit reviews what you already have against the 13 domains; the IT Documentation Build follows the ten steps above for you. Each is $3,500 fixed, one-time, as shown on IT documentation pricing.

Ali works on-site across Orange County, Los Angeles County and Southern California from Irvine, and remotely with companies nationwide. We document and audit; we do not administer your systems. For a security review of the network itself, see our internal security audit.

Two technicians in a data center aisle after documenting a network
Related

Where to go next

Network documentation

What a finished set of network diagrams and device records looks like, with a Harborview sample.

IT documentation checklist

Tick what your company can produce today and see where the gaps are.

Ali Hassani, CISO, OC Security Audit
CISO-led

Guided by Ali Hassani, CISO

Certified CISO (C|CISO) and CISSP with 25+ years in IT, cybersecurity, compliance and infrastructure, and dozens of Microsoft and Cisco certifications, including MCSE, MCITP, MCSA Security, CCNP and CCNA. Ali follows this same ten-step, read-only sequence on every documentation project, on-site or remote.

FAQ

Questions about documenting a network

How long does it take to document a network?

The time depends on the number of sites and devices, how much is already recorded and how quickly access is granted, so we confirm the scope and schedule on a 30-minute call before any work starts. The price does not change with the schedule: an IT Documentation Build is $3,500 fixed, one-time.

Can we document the network ourselves?

Yes. The ten steps above are the method we use. Some teams start internally and then bring us in for an independent audit of the result.

Is network scanning safe?

Scanning should only happen with written authorization, in an agreed window, and with settings that avoid disrupting sensitive devices such as medical or industrial equipment. If in doubt, rely on exports from switches, DHCP and the firewall instead.

What should we document first?

Start with what hurts most in an outage: internet circuits, the firewall, core switches and the IP plan. Then add wireless, servers, cloud and data flows.

How do we keep the documentation current?

Make updating the records a required step in every change, keep configuration backups running, and review the whole set at least annually and after major changes.

Implementation partner

OC Security Audit documents and audits; it stays independent of the administration of your systems. If you want hands-on work, IT Perfection can fix what the documentation uncovers and keep the records current as part of managed IT.

IT Perfection managed IT
Sources

Sources and references

  1. CIS Controls v8.1 Safeguard 12.4 (CIS Controls Assessment Specification)
  2. Auvik network mapping (Auvik)
  3. NetBox platform (NetBox Labs)
  4. Freshservice IT Asset Management 2026 (Freshworks)
  5. Configuration backup tools and cloud settings (ControlMonkey)
  6. ITFlow as an open-source alternative (Flamingo)

Auvik, Nmap, NetBox, Device42, Freshservice, Microsoft Visio, draw.io, Lucidchart, Oxidized, Unimus, RANCID, SolarWinds, ManageEngine, IT Glue, Hudu, ITFlow and SharePoint are trademarks of their respective owners. OC Security Audit is independent and not affiliated with or endorsed by any vendor named on this page.

Network switch with patch cables connected in a rack

Want the ten steps done for you?

Tell us about your sites and what you already have on file. Schedule a consultation and we will scope the work on a 30-minute call.

Irvine, Orange County and Southern California on-site; remote nationwide. Fixed one-time price: $3,500.