Network Documentation, Diagrams, and Course Capstone Lab

Why Network Documentation Matters

Every professional network exists in two places: the physical world of cables, switches, and routers, and on paper (or in a file) as documentation. When a device fails at 2 a.m., the technician who responds needs accurate diagrams and address tables immediately. Poor or missing documentation turns a 20-minute fix into a three-hour investigation. Professional documentation is not optional—it is a deliverable, just like a working configuration.

This lesson is your course capstone. You will build a small multi-VLAN, multi-router lab network and produce a complete documentation package that meets the standards employers expect and that CompTIA A+, Network+, and Cisco certifications test.

Types of Network Documentation

Logical diagram — Shows how devices communicate: IP addresses, VLANs, routing protocols, and the relationships between network segments. Physical locations and cable lengths are not the focus. Logical diagrams use standard shapes (cloud for internet, rectangle for switch, cylinder for server) so any trained technician can read them.

Physical diagram — Shows where devices are physically located: rack positions, room numbers, patch-panel ports, and cable paths. A physical diagram helps a technician trace a cable in the real world.

IP address management (IPAM) table — A structured table listing every interface, its IP address, subnet mask (or prefix length), default gateway, and VLAN assignment. Every interface on every device gets a row. Gaps in this table cause troubleshooting errors.

Cable run log — Records every physical cable: the source device and port, the destination device and port, cable type (Cat 5e, Cat 6, fiber), length, and any label applied to the cable. This log lets you find the right cable without tracing each one by hand.

Configuration archive — A saved copy of the running configuration from every managed device. On Cisco equipment, `show running-config` produces the complete configuration. Copying that output to a text file gives you a restore point and an audit trail. Configuration archives should be version-controlled and date-stamped.

Change log — A chronological record of every change made to the network: what changed, when, who made the change, and why. Even in a lab, practicing change-log discipline builds a professional habit.

Building Your Lab Network

Your capstone lab network contains two Cisco switches (each carrying multiple VLANs), one Cisco router running OSPF, one wireless access point (WAP), and four client PCs. Before you connect a single cable, sketch your logical diagram first. Assign IP address ranges to each VLAN before you configure anything. This planning step prevents address conflicts that are difficult to untangle after the fact.

When drawing the logical diagram in draw.io or on paper, use consistent symbols and label every link with the VLAN ID or IP subnet it carries. Label every device with its hostname. Place the router at the top, switches in the middle tier, and clients at the bottom. The WAP connects to one switch and serves wireless clients.

As you run each Ethernet cable, fill in the cable run log immediately—do not wait until the end. It takes five seconds to write down "Sw1 Fa0/1 → Router Gi0/0, Cat 6, 3 ft, label A1" and much longer to reconstruct it later.

IP Address Table Best Practices

Use a spreadsheet or the provided template. Required columns: Device Name, Interface, IP Address, Prefix Length, VLAN, Default Gateway, Notes. Include loopback interfaces on routers—they matter for OSPF router IDs. Record the WAP management IP separately from the wireless client subnet. Every subnet needs its network address, broadcast address, and usable range documented so future engineers know what space is available.

Configuration Backup Procedure (Cisco)

1. Connect to the device via console or SSH.

2. Enter privileged EXEC mode: `enable`

3. Type `show running-config` and let the output scroll completely.

4. Copy all output from the terminal window.

5. Paste into a plain-text file named with the device hostname and date (e.g., `SW1_2025-06-10.txt`).

6. Save to a USB drive or shared network folder.

Do this for every Cisco device in the lab—both switches and the router. A documentation package with missing config backups is incomplete.

Ping Matrix and Verification

A ping matrix is a table with source hosts across the top and destination hosts down the side. Every cell records Expected (reachable or not, based on your VLAN and routing design) and Actual (the result of running the ping). A mismatch between expected and actual identifies a misconfiguration. Complete the matrix last, after all other documentation is assembled, so you are verifying a fully documented network—not guessing.

Safety in the Lab

IT lab environments present real hazards. Follow these rules:

• Electrical safety: Never open a powered device's chassis. Power supplies inside switches and routers carry hazardous voltages. If a device is malfunctioning and needs internal inspection, power it off and unplug it before opening.
• Cable management: Keep cables bundled and off the floor to prevent trip hazards. Secure cables to racks or table edges with Velcro straps, not permanent ties, so they can be re-routed.
• ESD (electrostatic discharge): When handling network interface cards, RAM, or other components outside a chassis, wear an anti-static wrist strap connected to an unpainted metal chassis ground. Place components on an anti-static mat.
• Ergonomics: Adjust monitor height and chair position before long documentation sessions. Repetitive strain from extended keyboard use is a real occupational risk in IT.
• Data safety: Never save real customer data on lab equipment. USB drives used in the lab should be scanned before use on any production system.

Compiling the Final Package

Organize your deliverables in this order: (1) logical diagram, (2) IP address table, (3) cable run log, (4) configuration backup files, (5) ping matrix, (6) change log. A table of contents on the first page is a professional touch. The instructor will grade your package against a 20-point rubric; passing is 16 of 20.