Network Documentation and Diagrams

Network documentation is the collection of records that describe the design, configuration, and operation of a network. It includes diagrams, configuration files, IP address management (IPAM) records, inventory lists, change logs, and standard operating procedures. Diagrams are visual representations of the network's topology at various layers of the OSI model. The primary purpose is to provide a single source of truth that enables engineers to understand, troubleshoot, and modify the network correctly.

On the N10-009 exam, you must be able to distinguish between different types of diagrams and documentation, identify the appropriate diagram for a given scenario, and understand the consequences of poor documentation.

Physical topology diagrams show the actual physical layout of devices, cables, and connections. They include:

Logical topology diagrams show how data flows through the network, independent of physical layout. They include:

The exam tests your ability to choose the correct diagram type. For example, if a technician needs to trace a cable from a switch to a patch panel, a physical diagram is needed. If an engineer is planning a routing change, a logical diagram is appropriate.

CompTIA expects you to recognize standard network diagram symbols. These are often based on Cisco icons or generic icons from standards like ISO or IEEE. Common symbols include:

Connectors are represented by lines:

Additionally, diagrams often include annotations for:

Rack diagrams show the front and rear views of equipment racks, detailing:

Wiring schematics document cable runs from end to end, including:

Site surveys document the physical environment for wireless networks. They include:

On the exam, know that a site survey is performed before deploying WLAN to optimize coverage and capacity.

Configuration documentation includes:

Baselines are performance snapshots taken during normal operation. They document:

Baselines are critical for identifying anomalies and capacity planning.

Change management documentation records every modification to the network, including:

Audit logs track access to devices and configuration changes. They are essential for compliance (e.g., PCI-DSS, HIPAA) and for troubleshooting unauthorized changes.

SOPs are step-by-step instructions for common tasks such as:

Well-documented SOPs ensure consistency and reduce human error.

Tools include:

While documentation is often created manually, network engineers use commands to gather data for documentation:

show running-config
show startup-config
show vlan brief
show interface status
show cdp neighbors
show lldp neighbors
show ip route
show ip arp
show mac address-table
show spanning-tree

For wireless site surveys, tools like Ekahau or AirMagnet are used.

Each serves a distinct purpose, and the exam will ask you to match the documentation to the need.

Scenario 1: Data Center Migration A financial services company is moving from an on-premises data center to a colocation facility. The network team must document every cable, device, and configuration before the move. They use physical topology diagrams to label each cable at both ends with a unique ID (e.g., CBL-001). Rack diagrams show the exact U position of each switch and server. During the move, they disconnect cables according to the diagram and reconnect in the new facility. Without this documentation, re-cabling would take weeks instead of days. Common issues: cables not labeled per diagram, devices not in expected rack positions, power requirements not documented. The solution is to perform a pre-move audit by physically verifying every connection against the diagram.

Scenario 2: Wireless Site Survey for a Hospital A hospital needs to deploy Wi-Fi for mobile medical devices. An engineer conducts a site survey using Ekahau software. They import floor plans and place virtual APs to simulate coverage. The survey reveals interference from MRI machines and thick concrete walls. The engineer adjusts AP placement and channel selection (using 5 GHz to avoid cordless phone interference on 2.4 GHz). The final documentation includes heat maps showing signal strength (minimum -67 dBm for voice), channel assignments, and AP mounting locations. After deployment, a post-survey verifies coverage. Problems arise if the survey is done when the hospital is empty (no interference from people) or if APs are installed at incorrect heights.

Scenario 3: Compliance Audit for a Retail Chain A retail chain must comply with PCI-DSS. The auditor requests network diagrams, firewall rule sets, and change logs. The network team provides logical diagrams showing the segmentation between the cardholder data environment (CDE) and the corporate network. They also provide a configuration baseline for all firewalls and a change management log with approvals and rollback plans. The auditor finds that one diagram is outdated—it shows a VLAN that was decommissioned six months ago. This results in a finding. The team must update the diagram immediately and implement a quarterly review process. The lesson: documentation must be a living record, not a one-time project.