Les_26_W13_Praktijk - Documentatie

• newEditor
• ICT
• MBO
• Studiejaar 1

CASUS KEES DE BIJ

Een netwerk dat niemand begrijpt,

is een netwerk dat niemand kan beheren.

Vandaag leg je alles vast: technisch voor jezelf, begrijpelijk voor Kees.

Open deze slide pas ná je vraag aan de klas — bouw eerst de spanning op.

CURIO · ICT SYSTEM ENGINEER N4

PRAKTIJKCASUS 1

LES 26

WEEK 10 · SoHo-netwerk Kees de Bij

Technische documentatie & handleiding

Een technisch document van 8 secties én een jargonvrije gebruikershandleiding voor de klant.

★ MAIN QUEST +250 XP

Curio | ICT System Engineer N4 | Les 20 | Week 10 | Praktijk

Lesopbouw · 135 minuten

Je kent de structuur vooraf — zo bewaak je zelf je tempo. De lestimer telt mee.

10 min

Intro + templates bekijken

45 min

Technisch document blok 1: diagram, hardware, IP-tabel (Pomodoro)

10 min

Pauze

45 min

Technisch document blok 2: configuraties, wachtwoorden, troubleshoot

15 min

Gebruikershandleiding starten

10 min

Peer review: ander team leest je handleiding

CURIO │ ICT System Engineer N4 │ Praktijk-casus 1: Kees de Bij │ Lesopbouw

Les 20 · Week 10

Leerdoelen van deze les

TOEPASSEN

• Je schrijft een technisch document (±10 pag.) voor het netwerk

• Je maakt een gebruikershandleiding (±5 pag.) voor Kees

CREEREN

• Je stelt een professioneel netwerkdiagram op

• Je documenteert alle configuraties en wachtwoorden

EVALUEREN

• Je beoordeelt via peer review of de handleiding begrijpelijk is voor Kees

CURIO │ ICT System Engineer N4 │ Praktijk-casus 1: Kees de Bij │ Leerdoelen

Les 20 · Week 10

Twee documenten, twee lezers

Een technicus en Kees hebben heel verschillende informatie nodig. Schrijf voor de juiste lezer.

Technisch document (8 secties)

Voor een technicus: diagram, hardware-overzicht, IP-tabel, configuraties, wachtwoorden en troubleshooting.

Gebruikershandleiding

Voor Kees, in gewone taal: hoe verbind ik WiFi, hoe kom ik bij mijn bestanden, hoe bekijk ik de camera?

Een goed diagram

Met draw.io: alle apparaten én hun verbindingen. Een tekening zegt vaak meer dan een pagina tekst.

Schrijven zonder jargon

Peer review is de test: laat een ander team je handleiding lezen. Begrijpt iemand zonder voorkennis het?

CURIO │ ICT System Engineer N4 │ Praktijk-casus 1: Kees de Bij │ Vakinhoud

Les 20 · Week 10

Aan de slag

1

Bouw het technisch document op volgens de 8 secties uit de Documentatie-Structuur.

2

Teken het netwerkdiagram met alle apparaten en hun verbindingen.

3

Schrijf de gebruikershandleiding voor Kees (WiFi + NAS), zonder jargon.

4

Laat een ander team je handleiding lezen en verwerk hun feedback.

Test je handleiding écht: laat iemand die het netwerk niet kent ermee verbinden. Lukt dat niet, dan is je handleiding nog niet af.

CURIO │ ICT System Engineer N4 │ Praktijk-casus 1: Kees de Bij │ Opdracht

Les 20 · Week 10

XP VERDIENEN MET DEZE LES

TOTAAL +250 XP

Technisch document compleet

+125

Gebruikershandleiding

+75

Peer review gedaan

+50

WEEKLY CHALLENGE

BEST DOCUMENTATION — de docent speelt Kees: lukt het hem om met jullie handleiding de WiFi te verbinden? Winnaar +100 XP.

BADGE

Professionele layout +75

Curio | ICT System Engineer N4 | Les 20 | Week 10 | Praktijk

SIDE QUESTS · VOOR SNELLE TEAMS

Side Quest 1

Maak een video-handleiding met een schermopname. +100 XP

Side Quest 2

Vat het netwerk samen in een infographic van één pagina. +75 XP

DIT IS JE BPV-PORTFOLIO

Deze documenten neem je straks mee naar je stage. Goede documentatie is wat een engineer professioneel maakt.

Curio | ICT System Engineer N4 | Les 20 | Week 10 | Praktijk

EINDE VAN DE LES

Wat heb je vandaag bereikt?

✓ Technisch document in 8 secties opgesteld

✓ Professioneel netwerkdiagram getekend

✓ Gebruikershandleiding voor Kees geschreven

✓ Peer review verwerkt

XP DEZE LES

+250 XP

VOLGENDE PRAKTIJKLES

Presentatie voorbereiden

Slides maken en oefenen met peer feedback

Update het scoreboard · zet je portfolio bij · tot de volgende keer!