Dokumentationsmall

Använd den här mallen vid varje bygge, från Bygge 1 till slutprojektet. Kryssen sparas i din webbläsare, ett bygge i taget – öppnar du sidan igen inför nästa bygge börjar du om från noll.

Dokumentationen bär gränsen mellan E och C. Kriterierna skiljer på "enkel" dokumentation för E och "noggrann" dokumentation för C – samma ord som skiljer betygen i övrigt. Ett välbyggt system med en tunn dokumentation stannar på E, oavsett hur bra det fungerar på bordet. A kräver dessutom "utförlig" dokumentation, och att du kan sätta bygget i ett större sammanhang.

Nivå E — enkel dokumentation

Vad systemet gör. Några meningar som beskriver syftet och hur systemet används. Skriv så att någon som inte sett bygget förstår vad det är till för.
Kopplingsschema. En bild eller ritning som visar hur komponenterna sitter ihop. Handritat och fotograferat duger, så länge det går att läsa.
Koden. Koden du skrivit, bifogad eller inklistrad, med kommentarer på de rader som inte förklarar sig själva.
Vad som gick fel. Minst ett fel du stötte på och vad du gjorde åt det, oavsett om det löstes eller inte. En dokumentation utan ett enda fel berättar sällan hela historien.

Nivå C — lägg till, gör noggrann

Motiverade komponentval. Inte bara vilka komponenter du använde, utan varför just de. Koppla motiveringen till en beräkning eller ett datablad, inte till att "det var vad som fanns i lådan".
Mätvärden med enhet. De värden du faktiskt mätt under bygget – spänning, ström, resistans, tid, vinkel, vad som nu är relevant. Alltid med enhet.

De fyra E-punkterna gäller fortfarande, men mer noggrant: exempel i stället för påståenden, mätvärden i stället för gissningar.

Nivå A — lägg till, gör utförlig

Jämförelse med en industriell tillämpning. Hur löses samma typ av problem i ett riktigt system utanför skolan – en hiss, en bilfabrik, ett kylskåp? Vad är likt, vad har du förenklat, och varför var det rimligt att förenkla just där.
Vad du skulle ändra och varför. Om du byggde om systemet i dag, vad skulle du göra annorlunda? Kräver att du kan se ditt eget bygge utifrån, inte bara konstatera att det fungerade.