Skip to main content
← Unit 3: Managing Many Connections

Code Scholars Tutoring · AP Networking

3.6 Documenting What You Built

How it works

A network nobody has written down is a network only its builder can repair. Documentation records addressing, grouping, and the reasoning behind boundaries.

Record what was changed, why, and how it was verified. The reasoning is the part that saves the next person time.

Common error

Documentation that only lists settings, without saying why they were chosen, cannot be safely changed later.

Worked example

Assess whether a change record is sufficient for the next technician.

Evidence

Change: moved printer
Recorded address: 10.0.10.45
Missing: VLAN, port, reason, tests, rollback

The address alone does not explain where the printer connects or which workflows depend on it. Record old and new settings, physical port, VLAN, owner, reason, approver, verification results, and a rollback plan. Store documentation where authorized staff can find it.

Exercises

3.6.1

Write a short verification note after moving a printer from a guest segment to a staff segment.

Show solution

Record that an authorized staff workstation printed a test page, a guest device could no longer open the printer service, and the printer retained its approved address after reconnecting. Include the time and change identifier.

3.6.2

Why should a network diagram and address inventory be updated in the same change process?

Show solution

Otherwise each may describe a different network state, causing incorrect diagnosis or unsafe later changes. Link both updates to the same approved change and verification record.

Need help with this topic?

Work through questions with a tutor and get help with the steps you find difficult.

Get help with this topic