připomenutí předchozí hodiny a uvedení problému „README a základní dokumentace“. 5–12 min: stručná teorie – README, název projektu, účel, instalace, spuštění, licence. 12–18 min: společná ukázka prvního kroku a kontrolních kritérií. 18–36 min: samostatná práce nebo práce ve dvojici – Vytvořit README pro program nebo prototyp a nechat jej ověřit spolužákem. 36–41 min: vzájemná kontrola podle zadání a oprava zjištěné chyby. 41–45 min: uložení výstupu (README v repozitáři), krátký exit ticket a pojmenování dalšího kroku.
Správa verzí a dokumentace · 45 minut
README a základní dokumentace
Žák připraví stručný návod, popis účelu a způsob spuštění projektu.
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číš
Správa verzí uchovává historii práce a dokumentace vysvětluje, co projekt dělá, jak se používá a proč se změnil.
V hodině „README a základní dokumentace“ je hlavním cílem: Žák připraví stručný návod, popis účelu a způsob spuštění projektu. Nejde pouze o dokončení jednotlivých kliknutí nebo příkazů; důležité je umět vysvětlit, proč zvolený krok vede k cíli a co se v průběhu práce mění.
Klíčové pojmy README, název projektu, účel, instalace, spuštění tvoří společný jazyk pro popis řešení. Při praktické práci v prostředí „Textový editor, Markdown, repozitář“ sleduj vstup, jednotlivé kroky, mezivýsledek a způsob kontroly. Pokud některý krok nelze popsat nebo zopakovat, postup ještě není dostatečně přesný.
Praktická část vychází ze zadání: Vytvořit README pro program nebo prototyp a nechat jej ověřit spolužákem. Výsledkem musí být „README v repozitáři“. Hotový výstup nestačí pouze ukázat; musí být možné doložit, že vznikl z pracovních podkladů a že splňuje uvedená hodnoticí kritéria.
Před odevzdáním ověř zejména: Úplnost a ověřitelnost návodu. U programů nebo modelů použij více vstupů, u diagramů zkontroluj vztahy a popisky, u dokumentace ověř úplnost. Chybu nejprve přesně popiš, potom změň jen jednu věc a znovu výsledek otestuj.
Slovníček pojmů
README
Úvodní dokument projektu popisující jeho účel, spuštění, strukturu a použití.
název projektu
Jednoznačné a srozumitelné označení projektu používané v dokumentaci, složkách a prezentaci.
účel
Důvod existence řešení a přínos, kterého má jeho použitím být dosaženo.
instalace
Postup, kterým se software nebo projekt připraví ke spuštění v cílovém prostředí.
spuštění
Zahájení běhu programu nebo příkazu v určitém prostředí.
licence
Právní pravidla určující, jak lze dílo nebo software používat, upravovat a dále šířit.
03
ŘÍZENÁ PRÁCE
Postup krok za krokem
- 01
Ve studentské lekci si přečti cíl a otevři pracovní podklady. Připrav prostředí: Textový editor, Markdown, repozitář. Originální podklady ponech beze změny a pracuj s kopií ve vlastní složce.
- 02
Pojmenuj pracovní složku ve tvaru „63_readme-a-zakladni-dokumentace_prijmeni“. Uvnitř odděl zdrojové soubory, vlastní práci a výsledný export.
- 03
Rozděl zadání na menší ověřitelné kroky: Vytvořit README pro program nebo prototyp a nechat jej ověřit spolužákem. Nejprve vytvoř nejjednodušší funkční nebo srozumitelnou variantu.
- 04
Po každém významném kroku výsledek spusť, otevři nebo jinak zkontroluj. Zapisuj testovací vstup, skutečný výsledek a případnou opravu; neměň více nezávislých věcí najednou.
- 05
Porovnej práci s kritérii „Úplnost a ověřitelnost návodu“. Oprav alespoň jednu konkrétní slabinu zjištěnou vlastní nebo vrstevnickou kontrolou.
- 06
Ulož zdrojovou i výslednou podobu. Odevzdej „README v repozitáři“ v požadovaném formátu a přidej krátké zdůvodnění, jak jsi správnost ověřil/a.
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í.
.TXT
63 Podklady Readme
↓Pracovní podklad určený k samostatnému zpracování.
63_PODKLADY_README.txt · 1 kB.MD
63 Repozitar Scenar
↓Pracovní podklad určený k samostatnému zpracování.
63_repozitar_scenar.md · 1 kB.TXT
63 Historie Zmen
↓Pracovní podklad určený k samostatnému zpracování.
63_historie_zmen.txt · 1 kBDů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. Startovací otázkaStačí 2–3 věty; důležitý je konkrétní výchozí příklad.
Co už o tématu „README a základní dokumentace“ víš? Uveď konkrétní příklad nebo situaci.
2. Práce s pojmyDefinici spoj s konkrétním krokem, hodnotou nebo částí výstupu.
Vysvětli vlastními slovy alespoň tři pojmy: README, název projektu, účel, instalace, spuštění. Ke každému přidej použití v dnešní úloze.
3. Rozhodnutí a zdůvodněníUveď nejméně dvě možné varianty a kritérium volby.
Které rozhodnutí je při řešení úkolu „Vytvořit README pro program nebo prototyp a nechat jej ověřit spolužákem.“ nejdůležitější a podle čeho je uděláš?
4. Plán praktické prácePostup má mít vstup, očíslované kroky, kontrolu a očekávaný výstup.
Rozepiš vlastní postup k zadání: Vytvořit README pro program nebo prototyp a nechat jej ověřit spolužákem.
5. SebekontrolaKaždou otázku musí být možné zodpovědět důkazem z práce.
Převeď hodnoticí kritéria na kontrolní otázky: Úplnost, ověřitelnost návodu.
6. Exit ticketOdpověď musí být konkrétní a vztahovat se k dnešní práci.
Napiš jeden pochopený princip, jednu provedenou opravu a jeden další krok.
06
PRAKTICKÁ PRÁCE
README a základní dokumentace
Vytvořit README pro program nebo prototyp a nechat jej ověřit spolužákem. 1. Pojmenuj pracovní složku ve tvaru „63_readme-a-zakladni-dokumentace_prijmeni“. Uvnitř odděl zdrojové soubory, vlastní práci a výsledný export. 2. Rozděl zadání na menší ověřitelné kroky: Vytvořit README pro program nebo prototyp a nechat jej ověřit spolužákem. Nejprve vytvoř nejjednodušší funkční nebo srozumitelnou variantu. 3. Po každém významném kroku výsledek spusť, otevři nebo jinak zkontroluj. Zapisuj testovací vstup, skutečný výsledek a případnou opravu; neměň více nezávislých věcí najednou. 4. Porovnej práci s kritérii „Úplnost a ověřitelnost návodu“. Oprav alespoň jednu konkrétní slabinu zjištěnou vlastní nebo vrstevnickou kontrolou.
Očekávaný výstup
README v repozitáři
07
DŮKAZ O UČENÍ
Odevzdání praktického úkolu
ZIP balíček
README v repozitáři
Dokonči praktickou práci a odevzdej důkaz: README v repozitáři. Použij studentské podklady, zpracuj je samostatně a před odevzdáním projdi kontrolní kritéria. Hotové řešení je dostupné pouze v učitelské části.
Zatím nebyl vybrán žádný soubor.
V samostatném HTML se ukládají odpovědi a názvy vybraných souborů pouze do tohoto prohlížeče. Skutečný upload provede aplikace Kurzy/Studio.
08
ZÁVĚREČNÁ KONTROLA
Test
09
REFLEXE
Co si z lekce odnášíš
Dokončeno neznamená pouze vytvořeno. Po dokončení lekce prokážeš cíl odevzdáním výstupu: README v repozitáři. Výsledek zkontroluj podle kritérií: Úplnost a ověřitelnost návodu.