Claude DesktopClaude CodeStřední

Dokumentace a reproducibility

Cíl dne

Zdokumentovat projekt tak aby ho mohl spustit kdokoliv

Cíl dne

Dobry kod bez dokumentace je ztracen za 6 měsíců. Dnes napises README ktere zachrani budoucno tebe.

V Projectu: Pokračuj v chatu uvnitř svého Projectu z Day 1 — Custom Instructions šetří kontext, knowledge files (glosář, cheat sheet) máš po ruce. Pokud Claude použije termín, který si nepamatuješ, řekni: „Vysvětli mi to z mého glosáře."

Vzorový prompt

Na zaklade meho Python projektu pro financni reporting
napiš README.md ktery obsahuje:

1. Co projekt dela (2-3 vety, bez zbytecneho jazyka)
2. Predpoklady:
   - Python verze
   - Operacni system
   - Potrebne soubory
3. Instalace krok za krokem (presne prikazy)
4. Konfigurace (co nastavit v config.py)
5. Spusteni (presne prikazy, s priklady)
6. Vystupy (jake soubory se vygeneruji, kde)
7. Troubleshooting - 3 nejcastejsi chyby:
   - Jak je poznat
   - Jak je opravit

Pis cesky. Strucne a prakticky - ne akademicky.
Kazdy krok ma byt prikaz ktery muzu zkopirovat.

Výstup dne

Soubor README.md ktery dalsi clovek muze sledovat bez tvoji pomoci.

Co budeš mít na konci

Kompletni dokumentace projektu

AI Univerzita — soukromá vzdělávací platforma