Ako funguje vysvetľovanie kódu
Mapa vysvetliteľných položiek, jedna téma jedna konverzácia a dokumenty, ktoré zostanú v projekte.
Vysvetľovanie je odpoveď na otázku, ktorú nikto nevie dobre položiť: „čo je toto za projekt a ako to funguje?“ Namiesto toho, aby ste sa dopytovali v chate a potom odpoveď hľadali v tristoriadkovej konverzácii, dostanete rozcestník tém a z každej jeden dokument, ku ktorému sa dá vrátiť.
Mapa vysvetliteľných položiek
Prvá vec, ktorú v záložke Projekt → Vysvetlenia uvidíte, je výzva k zostaveniu mapy. Mapa je zoznam toho, čo v tomto projekte stojí za vysvetlenie — vrstvy, moduly, tok dát, konkrétne súbory. Zostaví ju Agent, pretože len on vie, čo v projekte je.
Zostavenie beží na pozadí a výsledkom nie je správa v konverzácii, ale súbor v projekte. Nemusíte pri tom byť — mapa sa v aplikácii objaví sama, len čo ju Agent zapíše.
V mape sú témy v skupinách. Prvá skupina je tá obecná: architektúra, návrh, tok dát. To sú otázky, ktoré sa dajú položiť, bez toho, aby ste poznali jediný súbor — preto sú prvé. Konkrétne časti sú pod nimi.
Projekt sa mení, mapa nie. „Zostaviť mapu znova“ je preto tlačidlo, ktoré používajte, keď sa projekt posunul — po väčšom refaktore je stará mapa skôr mätúca než užitočná.
Jedna téma, jedna konverzácia
Ťuknutím vyberiete jednu tému alebo viac a dáte Vysvetliť. Odpoveď nejde do hlavnej Konverzácie, ale do vlastnej, pomenovanej podľa témy.
To je zámer, nie detail. Kto rieši prácu, nechce mať chat zaplavený výkladom architektúry; kto sa učí projekt, chce sa k téme vracať, a nie ju loviť v chate. V tej konverzácii sa navyše dá dopytovať ďalej — a otázky zostanú u témy, kam patria.
Rozpracované a hotové
Nad mapou sú dve sekcie. Rozpracované témy sú tie, o ktorých už konverzácia beží. Hotové vysvetlenia sú súbory v projekte, v docs/explanations/ — jedna téma jeden súbor.
Rozdiel medzi nimi je v tom, čo prežije. Konverzácia patrí Serveru a po prepnutí projektu alebo vyčistení zmizne. Súbor v projekte zostane, ide do gitu a prečíta si ho aj kolega, ktorý coden nemá.
Čo už vysvetlené je, sa v mape neponúka druhý raz. Keby sa ponúkalo, nepoznali by ste, či pokračujete, alebo začínate od nuly.
Na čo je to dobré
- Nový projekt. Zostavíte mapu, vysvetlíte si obecnú skupinu a máte za dvadsať minút prehľad, ktorý by ste inak skladali dva dni.
- Cudzí kód. Presne ten súbor, na ktorý sa chystáte siahnuť, si necháte vysvetliť skôr, než do neho zapíšete.
- Dokumentácia, ktorá vznikne ako vedľajší produkt. Súbory v
docs/explanations/sú písané pre čítanie, nie pre model — a zostanú v projekte. - Čítanie bez spojenia. Hotové vysvetlenia sú v zrkadle Dokumentov, takže sa otvoria aj offline.
Bez spojenia
Zadať vysvetlenie bez spojenia so Serverom nejde — na druhej strane musí niekto pracovať. Už uložené sa ale čítajú ďalej a aplikácia to povie hneď, namiesto toho, aby tlačidlo len nereagovalo.
Zaseklo sa to inde, než čo je tu? Napíšte na support@coden-app.com.