Jak funguje vysvětlování kódu
Mapa vysvětlitelných položek, jedno téma jedna konverzace a dokumenty, které zůstanou v projektu.
Vysvětlování je odpověď na otázku, kterou nikdo neumí dobře položit: „co je tohle za projekt a jak to funguje?“ Místo abyste se doptávali v chatu a pak odpověď hledali ve třistařádkové konverzaci, dostanete rozcestník témat a z každého jeden dokument, ke kterému se dá vrátit.
Mapa vysvětlitelných položek
První věc, kterou v záložce Projekt → Vysvětlení uvidíte, je výzva k sestavení mapy. Mapa je seznam toho, co v tomhle projektu stojí za vysvětlení — vrstvy, moduly, tok dat, konkrétní soubory. Sestaví ji Agent, protože jen on ví, co v projektu je.
Sestavení běží na pozadí a výsledkem není zpráva v konverzaci, ale soubor v projektu. Nemusíte u toho být — mapa se v aplikaci objeví sama, jakmile ji Agent zapíše.
V mapě jsou témata ve skupinách. První skupina je ta obecná: architektura, návrh, tok dat. To jsou otázky, které se dají položit, aniž byste znali jediný soubor — proto jsou první. Konkrétní části jsou pod nimi.
Projekt se mění, mapa nikoliv. „Sestavit mapu znovu“ je proto tlačítko, které používejte, když se projekt posunul — po větším refaktoru je stará mapa spíš matoucí než užitečná.
Jedno téma, jedna konverzace
Ťuknutím vyberete jedno téma nebo víc a dáte Vysvětlit. Odpověď nejde do hlavní Konverzace, ale do vlastní, pojmenované podle tématu.
To je záměr, ne detail. Kdo řeší práci, nechce mít chat zaplavený výkladem architektury; kdo se učí projekt, chce se k tématu vracet, a ne ho lovit v chatu. V té konverzaci se navíc dá doptávat dál — a otázky zůstanou u tématu, kam patří.
Rozpracovaná a hotová
Nad mapou jsou dvě sekce. Rozpracovaná témata jsou ta, o kterých už konverzace běží. Hotová vysvětlení jsou soubory v projektu, v docs/explanations/ — jedno téma jeden soubor.
Rozdíl mezi nimi je v tom, co přežije. Konverzace patří Serveru a po přepnutí projektu nebo úklidu zmizí. Soubor v projektu zůstane, jde do gitu a přečte si ho i kolega, který coden nemá.
Co už vysvětlené je, se v mapě nenabízí podruhé. Kdyby se nabízelo, nepoznali byste, jestli pokračujete, nebo začínáte od nuly.
K čemu je to dobré
- Nový projekt. Sestavíte mapu, vysvětlíte si obecnou skupinu a máte za dvacet minut přehled, který byste jinak skládali dva dny.
- Cizí kód. Přesně ten soubor, na který se chystáte sáhnout, si necháte vysvětlit dřív, než do něj zapíšete.
- Dokumentace, která vznikne jako vedlejší produkt. Soubory v
docs/explanations/jsou psané pro čtení, ne pro model — a zůstanou v projektu. - Čtení bez spojení. Hotová vysvětlení jsou v zrcadle Dokumentů, takže se otevřou i offline.
Bez spojení
Zadat vysvětlení bez spojení se Serverem nejde — na druhé straně musí někdo pracovat. Už uložená se ale čtou dál a aplikace to řekne rovnou, místo aby tlačítko jen nereagovalo.
Zaseklo se to jinde, než co je tady? Napište na support@coden-app.com.