Teknik 1 · inlämning onsdag 11 november

Dokumentationsmallen

Fem delar, 2–3 sidor plus bilder. Del 1, 3 och 4 skriver ni i par. Del 2 och 5 skriver du själv. Bifoga main.py och logg.md.

11 nov Inlämning Dokumentet, main.py och logg.md.

1. Varför dokumentationen väger tungt

Blocket bedöms på två saker ur kursplanen: att lösa tekniska problem, praktiskt och teoretiskt, och att dokumentera, visualisera och kommunicera tekniska lösningar. Roboten på banan är det praktiska. Allt annat – beräkningarna, flödesschemat, felsökningen, resonemanget – syns bara i dokumentationen.

En robot som klarar labyrinten med en dokumentation som bara säger "den fungerade" visar mindre än en robot som fastnade på nivå 1 med en dokumentation som visar exakt vad som gick fel, vad ni provade, och varför ni valde som ni gjorde.

2. De fem delarna

Del	Rubrik	Vad som ska in	Skrivs
1	Uppgiften	Vad skulle roboten klara? Vilken nivå siktade ni på, och varför den?	par
2	Hur roboten tänker	Ett flödesschema över labyrintlogiken. Handritat och fotat, eller i draw.io / Excalidraw. Varje beslut ska vara med: linje under mitten, korsning, återvändsgränd, mål.	var för sig
3	Koden	De viktigaste bitarna – tre eller fyra – med förklaring i egna ord: vad gör den, och varför ser den ut så? Inte hela filen.	par
4	Test och resultat	Vad testade ni, vad gick, vad gick inte. Mätvärden: tröskelvärden, hastighet, hur många körningar som lyckades av hur många. Bild eller kort film från banan.	par
5	Utvärdering	Vad skulle ni göra annorlunda? Vad var svårast, och hur löste ni det? Och hållbarhetsfrågan: vad händer med roboten och batterierna efter kursen – kan den repareras, återanvändas, återvinnas?	var för sig

Loggboken är råmaterialet

Del 4 och 5 skriver ni ur loggboken. Där står vad som strulade varje pass och hur ni löste det – det minns ingen fem veckor senare. Två elever i samma par får gärna ha olika flödesscheman och olika utvärderingar. Det är bra, inte fel.

3. Vad som skiljer E, C och A

	E	C	A
Del 2 flödesschema	Visar huvudflödet	Alla beslut är med, och det stämmer med koden	Stämmer med koden och visar vad som händer vid fel: tappad linje, hinder
Del 3 kod	Beskriver vad koden gör	Förklarar varför – kopplar kodrad till robotens beteende	Resonerar om alternativ: "vi provade bang-bang först, bytte till P-reglering för att …"
Del 4 test	Anger att det testades och hur det gick	Redovisar mätvärden och vad de ledde till	Drar slutsatser ur testerna som ändrade lösningen, och säger vad som inte gick att lösa och varför
Del 5 utvärdering	Nämner något att ändra	Motiverar ändringen ur testerna	Väger alternativ mot varandra, inklusive hållbarhet
Roboten	Bas eller nivå 1 med handledning	Nivå 1 självständigt, eller nivå 2 med handledning	Nivå 2 självständigt, eller utmaningen

Robotens nivå är ett belägg bland flera. Ett par som fastnade på nivå 1 men dokumenterar en genomarbetad felsökning kan mycket väl visa C.

4. Om flödesschemat

Ett flödesschema är en ritning av programmets beslut. Rutor för det roboten gör, romber för frågorna den ställer, pilar emellan. Det behöver inte vara snyggt – det behöver stämma med koden.

        ┌──────────────┐
        │  läs sensorn │◄─────────────────┐
        └──────┬───────┘                  │
               ▼                          │
        ◇ alla fem svarta?  ─ ja ─► ◇ fortfarande efter 5 cm? ─ ja ─► [ MÅL: stopp ]
               │ nej                      │ nej
               ▼                          ▼
        ◇ ingen svart?  ─ ja ─► [ vänd 180° ] ──┐    [ korsning: sväng vänster ] ──┐
               │ nej                            │                                  │
               ▼                                │                                  │
        [ följ linjen ] ────────────────────────┴──────────────────────────────────┘

Rita ett första utkast på papper över lovet. Det tar tjugo minuter, och det är det första ni gör pass 9 – innan någon rör koden.

5. Mallen

Kopiera den här till ert dokument (Word, Google Docs eller vad ni vill) och fyll i. Blocket går att markera och kopiera.

# Labyrintprojektet – dokumentation

Par: ___ och ___
Robot nr: ___
Nivå vi siktade på: ___

## 1. Uppgiften (par)
Vad skulle roboten klara? Vilken nivå siktade ni på och varför?

## 2. Hur roboten tänker (var för sig – skriv ditt namn)
Flödesschema. Rita för hand och fota, eller använd draw.io.
Alla beslut ska finnas med: linje under mitten, korsning, återvändsgränd, mål.

## 3. Koden (par)
Välj tre–fyra viktiga bitar. Klistra in dem. Förklara med egna ord vad de gör
och varför de ser ut så.

## 4. Test och resultat (par)
Vad testade ni? Vad gick, vad gick inte? Mätvärden: tröskelvärden, hastighet,
antal lyckade körningar. Bild från banan.

## 5. Utvärdering (var för sig – skriv ditt namn)
Vad skulle ni göra annorlunda? Vad var svårast, hur löste ni det?
Vad händer med roboten och batterierna efter kursen?

Bilagor: main.py och logg.md
Lämnas in senast onsdag 11/11.