| Obě strany předchozí revize Předchozí verze Následující verze | Předchozí verze |
| ai:platformy:claude-code:strukturace-dokumentace [05.05.2026 09:30] – Doplnění sekce o ADR (Architecture Decision Records) Petr Nosek | ai:platformy:claude-code:strukturace-dokumentace [05.05.2026 09:38] (aktuální) – Doplnění dvou klíčových principů: PROČ místo CO/JAK, AS IS místo changelogu Petr Nosek |
|---|
| |
| [[https://www.vibecoding.cz/download/strukturace-dokumentace-pro-claude-code-v2.pdf|Prezentace Ondřeje Tučného]] z akce Vibeco Ding Talks (20. 4. 2026) popisuje systém strukturování dokumentace pro projekty s Claude Code, který škáluje od malých repozitářů až po miliony řádků kódu. Výchozím bodem je [[https://vibecoding.cz|vibecoding.cz]] – konkrétně přístup Patricka Zandla, který funguje do určité velikosti projektu. Tato prezentace řeší, co dělat, když tento přístup přestane stačit. | [[https://www.vibecoding.cz/download/strukturace-dokumentace-pro-claude-code-v2.pdf|Prezentace Ondřeje Tučného]] z akce Vibeco Ding Talks (20. 4. 2026) popisuje systém strukturování dokumentace pro projekty s Claude Code, který škáluje od malých repozitářů až po miliony řádků kódu. Výchozím bodem je [[https://vibecoding.cz|vibecoding.cz]] – konkrétně přístup Patricka Zandla, který funguje do určité velikosti projektu. Tato prezentace řeší, co dělat, když tento přístup přestane stačit. |
| | |
| | ===== Co AI agent z dokumentace skutečně potřebuje ===== |
| | |
| | Dva principy, které stojí za celým přístupem: |
| | |
| | **Dokumentace pro AI odpovídá na PROČ, ne na CO nebo JAK.** |
| | CO a JAK jde přečíst přímo z kódu — agent to zvládne sám. Jediné, co z kódu vyčíst nejde, je záměr: proč byl zvolen tento přístup, jaké alternativy byly zamítnuty, co se tímto rozhodnutím vědomě obětovalo. Bez tohoto kontextu agent při každé nové session navrhuje „lepší" řešení, které ale ignoruje důvody, proč věci jsou tak, jak jsou. |
| | |
| | **AS IS místo changelogu.** |
| | Changelog zaznamenává historii změn — co se dělalo před rokem, před půl rokem. Pro AI agenta je tato historie bezcenná a škodlivá: zbytečně plní kontext a mate model tím, co už dávno neplatí. Místo toho dokumentace popisuje **aktuální stav systému** — jak věci fungují teď. Historie patří do verzovacího systému (git), ne do dokumentace pro agenta. |
| |
| ===== Kde plochá struktura přestává stačit ===== | ===== Kde plochá struktura přestává stačit ===== |
| * **Rozhodnutí se neztratí** – nejsou v commit messages, nepřekáží v docs/ | * **Rozhodnutí se neztratí** – nejsou v commit messages, nepřekáží v docs/ |
| * **Více agentů nebo vývojářů** – každý vidí historii a důvody rozhodnutí | * **Více agentů nebo vývojářů** – každý vidí historii a důvody rozhodnutí |
| | |
| | ==== Spec Kit jako konkrétní implementace tasks/ ==== |
| | |
| | [[ai:platformy:agenti-a-orchestrace:spec-kit|Spec Kit]] od GitHubu implementuje právě tuto TO BE stranu — generuje strukturu ''tasks/'' přes sadu příkazů (''constitution → specify → plan → tasks → implement''). Tučného framework říká //kde// TO BE dokumentace patří a //jaký// má životní cyklus; Spec Kit říká //jak// ji konkrétně vytvářet a udržovat. |
| | |
| | Jsou to tedy dvě doplňující se vrstvy, ne alternativy: Spec Kit pokrývá TO BE část, ale neřeší strukturu AS IS ''docs/'', dokumentaci u kódu ani MCP nástroj pro vyhledávání. |
| |
| ===== Substrát, ne metodika ===== | ===== Substrát, ne metodika ===== |
| * [[https://www.vibecoding.cz/download/strukturace-dokumentace-pro-claude-code-v2.pdf|Ondřej Tučný – Strukturace dokumentace pro efektivní použití s Claude Code]] (PDF, Vibeco Ding Talks, 20. 4. 2026) | * [[https://www.vibecoding.cz/download/strukturace-dokumentace-pro-claude-code-v2.pdf|Ondřej Tučný – Strukturace dokumentace pro efektivní použití s Claude Code]] (PDF, Vibeco Ding Talks, 20. 4. 2026) |
| * [[https://vibecoding.cz|vibecoding.cz]] – výchozí referenční základ (článek Patricka Zandla) | * [[https://vibecoding.cz|vibecoding.cz]] – výchozí referenční základ (článek Patricka Zandla) |
| | * [[ai:platformy:agenti-a-orchestrace:spec-kit|Spec Kit]] – nástroj pro TO BE část workflow |
| * [[https://adr.github.io|adr.github.io]] – nástroje a přehled ADR | * [[https://adr.github.io|adr.github.io]] – nástroje a přehled ADR |
| * [[https://adr.github.io/madr/|MADR – Markdown Architectural Decision Records]] | * [[https://adr.github.io/madr/|MADR – Markdown Architectural Decision Records]] |