Documentation — Server Logs, Network Diagrams & User Docs
How do we explain a system to a fellow tech — and to a user?
- Read and interpret simple server or event logs
- Draw a basic logical and physical network diagram of the school lab
- Produce user documentation (help sheet) for one common task
Overview
This week we practise the three main documentation styles a sysadmin uses. First, we read event logs to spot warnings and errors. Then we draw the school lab as both a logical diagram (router → switch → PCs) and a physical diagram (room layout, cable runs). Finally, we write a one-page help sheet — for a real user, not a tech.
Reading logs
Windows Event Viewer classifies entries as Information, Warning or Error. Warnings often precede errors — a disk warning today may be a crash next week. Filter, do not scroll: use the tool's filters to find the level and source that matter.
Logical vs physical diagrams
A logical diagram shows how data flows: router → switch → PCs, with IP ranges. A physical diagram shows where things live: room layout, cable runs, socket numbers. Both are needed — one for troubleshooting the network, the other for pulling cables.
User documentation
Users do not want to know how the printer driver talks to the print server. They want to know 'how do I print?' Write short, numbered steps with screenshots. Test the steps by giving them to someone who has never done the task.
Diagram the lab and write a help sheet
- Interpret 3 entries from a supplied Event Viewer log — say what each one means and how urgent it is.
- Draw a logical network diagram of your school lab (router → switch → PCs) with IP ranges.
- Draw a physical diagram of the same lab (room layout and cable runs).
- Write a one-page help sheet for a common task (e.g. how to print, how to reset your password).
- Ask another student to follow your help sheet exactly — record any step they get stuck on.
- Name the three event-log levels.
Reveal answer
Information, Warning, Error.
- Difference between logical and physical network diagrams?
Reveal answer
Logical shows data flow and IPs; physical shows room layout and cable runs.
- How do you know your help sheet is good?
Reveal answer
A first-time user can follow it exactly without asking for help.
Write a help sheet for the task you find hardest in the school lab.