připomenutí návaznosti a uvedení problému „Technická a uživatelská dokumentace“. 5–12 min: teoretické minimum – README, instalace, spuštění, vstupy, výstupy, omezení, licence. 12–18 min: společná ukázka postupu, modelu nebo kontrolních kritérií. 18–36 min: samostatná práce nebo práce ve dvojici – Napsat stručnou technickou část a uživatelský návod a nechat je ověřit spolužákem. 36–41 min: test, vzájemná kontrola nebo krátká konzultace. 41–45 min: uložení výstupu (README a uživatelský návod), zápis změny a exit ticket.
Testování, ladění a dokumentace programu · 45 minut
Technická a uživatelská dokumentace
Žák připraví dokumentaci pro dalšího vývojáře i běžného uživatele.
00
ČASOVÁ OSA
Struktura 45minutové hodiny
01
VIDEO LEKCE
Ukázka a vysvětlení postupu
▶
Video je připravené k doplnění
Video ukáže princip, první kroky, kontrolu a typickou chybu. Nebude obsahovat celý hotový upravitelný úkol.
provider: youtube · youtubeId: ""02
STUDIJNÍ MATERIÁL
Výklad: z čeho se učíš
Téma „Technická a uživatelská dokumentace“ patří do celku „Testování, ladění a dokumentace programu“. Nejde pouze o ovládání nástroje: cílem je porozumět rozhodnutím, která vedou od zadání k ověřitelnému digitálnímu výstupu.
Klíčové pojmy README, instalace, spuštění popisují základní stavební prvky dnešní práce. Pojmy vstupy, výstupy, omezení pomáhají výsledek kontrolovat, vysvětlit nebo porovnat s jinou variantou. Každý pojem proto použij v konkrétním kroku, nikoli jen v definici.
Pracovat budeš v prostředí „Markdown nebo textový dokument“. Nejprve si uchovej původní podklady, potom vytvoř pracovní kopii a změny prováděj po menších ověřitelných krocích. Po každé důležité změně výsledek otevři, spusť nebo porovnej s požadovaným chováním.
Praktické zadání zní: Napsat stručnou technickou část a uživatelský návod a nechat je ověřit spolužákem. Výsledkem je „README a uživatelský návod“. Nestačí, aby výstup pouze existoval; musí být možné doložit, že splňuje cíl: Žák připraví dokumentaci pro dalšího vývojáře i běžného uživatele.
Kvalitu posuzuj podle těchto hledisek: Úplnost, Srozumitelnost a ověřitelnost návodu. Před odevzdáním zkontroluj názvy a strukturu souborů, funkčnost na čistém nebo cílovém prostředí a připoj stručnou reflexi rozhodnutí, testu a případné opravy.
Slovníček pojmů
README
Úvodní dokument vysvětlující účel projektu, instalaci, spuštění, strukturu a způsob použití.
instalace
Pojem „instalace“ označuje konkrétní prvek nebo pravidlo používané při tématu této lekce; jeho význam se ověřuje na pracovním příkladu a podle výsledného výstupu.
spuštění
Pojem „spuštění“ označuje konkrétní prvek nebo pravidlo používané při tématu této lekce; jeho význam se ověřuje na pracovním příkladu a podle výsledného výstupu.
vstupy
Pojem „vstupy“ označuje konkrétní prvek nebo pravidlo používané při tématu této lekce; jeho význam se ověřuje na pracovním příkladu a podle výsledného výstupu.
výstupy
Pojem „výstupy“ označuje konkrétní prvek nebo pravidlo používané při tématu této lekce; jeho význam se ověřuje na pracovním příkladu a podle výsledného výstupu.
omezení
Pojem „omezení“ označuje konkrétní prvek nebo pravidlo používané při tématu této lekce; jeho význam se ověřuje na pracovním příkladu a podle výsledného výstupu.
licence
Pravidla stanovená držitelem práv, která určují, jak lze dílo používat, upravovat a šířit.
03
ŘÍZENÁ PRÁCE
Postup krok za krokem
- 01
Otevři prostředí „Markdown nebo textový dokument“ a vytvoř si vlastní pracovní složku s číslem lekce. Původní podklady neměň; nejprve je zkopíruj do pracovní verze.
- 02
Přečti zadání a napiš si jednou větou očekávaný výsledek: README a uživatelský návod. Označ vstupy, omezení a nejméně tři kontrolní kritéria.
- 03
Spusť startovní program beze změn a zapiš jeho současný výstup nebo chybu.
- 04
Doplň řešení po malých funkcích nebo krocích. Po každé změně spusť běžný, hraniční i neplatný vstup.
- 05
Proveď sebekontrolu podle kritérií: Úplnost; Srozumitelnost a ověřitelnost návodu. Zaznamenej alespoň jeden test nebo porovnání.
- 06
Ulož zdrojovou i výslednou verzi pod jednoznačnými názvy. Odevzdej „README a uživatelský návod“ a krátce popiš, jak jsi ověřil/a správnost.
04
PRACOVNÍ PODKLADY
Stáhni si soubory, se kterými budeš pracovat
Náhled ukazuje pouze strukturu a typ výsledku. Hotové upravitelné řešení ve studentské části není.
Důležité: Podklady jsou vstupy k práci, nikoli kompletní řešení. Vlastní výsledek musí vzniknout podle zadání, testu a reflexe.
05
OTEVŘENÉ ODPOVĚDI
Pracovní list
1. Výchozí představaNapiš konkrétní příklad, ne pouze obecný dojem.
Co už o tématu „Technická a uživatelská dokumentace“ víš a kde ses s ním setkal/a?
2. Práce s pojmyKe každému pojmu přidej situaci, ve které ovlivňuje rozhodnutí.
Vysvětli vlastními slovy alespoň tři pojmy: README, instalace, spuštění, vstupy, výstupy, omezení.
3. Rozhodovací situaceUveď kritérium, důkaz a možné omezení.
Jaké dvě možné varianty řešení připadají v úvahu a podle čeho mezi nimi rozhodneš? Téma: Technická a uživatelská dokumentace.
4. Plán praktické prácePostup musí obsahovat vstup, konkrétní kroky, kontrolu a výstup.
Rozepiš vlastní postup k zadání: Napsat stručnou technickou část a uživatelský návod a nechat je ověřit spolužákem.
5. SebekontrolaFormuluj kontrolní otázky, které lze skutečně zodpovědět ano/ne nebo měřením.
Jak ověříš, že je výstup „README a uživatelský návod“ správný? Vycházej z kritérií: Úplnost, Srozumitelnost a ověřitelnost návodu.
6. Exit ticketOdpověď má být konkrétní a vztahovat se k dnešní práci.
Napiš jeden princip, jednu provedenou kontrolu a jeden další krok.
06
PRAKTICKÁ PRÁCE
Technická a uživatelská dokumentace
Napsat stručnou technickou část a uživatelský návod a nechat je ověřit spolužákem.
Očekávaný výstup
README a uživatelský návod
07
DŮKAZ O UČENÍ
Odevzdání praktického úkolu
Soubor a krátká odpověď
README a uživatelský návod
Odevzdej výstup „README a uživatelský návod“. Přilož zdrojové soubory nebo export a krátce popiš, jak jsi výsledek zkontroloval/a.
Zatím nebyl vybrán žádný soubor.
Offline verze ukládá pouze odpovědi a názvy vybraných souborů v prohlížeči; skutečný upload provede Studio po napojení API.
08
ZÁVĚREČNÁ KONTROLA
Test
09
REFLEXE
Co si z lekce odnášíš
Dokončeno neznamená pouze vytvořeno. Výsledek je dokončený tehdy, když je uložený, otevřitelný, otestovaný a vysvětlitelný podle kritérií. Zapiš jednu provedenou kontrolu, jednu opravu a jeden další krok.