[Java lista] [allas] I-Logic Kft. 1 senior, 1 junior fejleszto

Gergely Hodicska felho at avalon.aut.bme.hu
2008. Aug. 31., V, 13:33:48 CEST


> Es igy utolag hogy sikerult doksit keszitni? 
Egyszer nekem neki kellett ugrani ennek a feladatnak. Annyi előnyöm 
volt, hogy azért nagyjából átláttam a folyamatokat, plusz dolgoztam több 
rendszeren is akkor már ott, valamint az én dolgom volt sok új dolog 
kialakítása. Kértem Confluence-t, JIRA-t.

Kb. úgy kezdtem neki, hogy a különböző területek vezetőivel nekiálltam 
beszélgetni, először papírra legyezgettem, hogy az adott csapat mivel is 
foglalkozik, kik vannak benne, mik az általános napi teendők, mik a 
felelősségeik, átfutottuk némileg a repójukat (már ha fejlesztéssel 
kapcsolatos csapat volt). Ezek alapján adódott egy váz a különböző 
területeken, amit aztán szétdobtunk a megfelelő embereknek, akik 
nekiálltak megírni. Persze olyan lett amilyen, simán lehetett látni, 
hogy ki volt az, aki komolyan vette, ki volt az, aki csak a feladatot 
akarta kipipálni.

> Elkezdtetek nyalazni a forrast, es irtatok hozza az anyagot?
Először még kicsit magasabb szinten zajlott a dolog. Amúgy is én valami 
olyasmi struktúrát szerettem volna kiépíteni, ahol a wiki-be nem kerül 
be minden apró-cseprő dolog.


Mostani helyemen a terv a következő: ha nekiállunk valamilyen nagyobb 
feladatak, akkor bekerül a wikibe egy leírás a tervezett 
megvalósításról. Probléma leírás, némi előtörténet (nekem ez utóbbi 
vesszőparipám, meggyőződésem, hogy gyakran enélkül nem is lehet 
megérteni pontosan az választott megoldást, de pláne nehéz jó irányba 
tovább vinni, viszont általában pont ez az a terület, amit legtöbben 
abszolút figyelmen kivül hagynak), milyen komponensek vesznek részt 
benne stb.. Ehhez jön DB terv a maga helyén. Ami már csak egy adott 
osztályt érint mondjuk, vagy valamilyen apróbb részlet, az már csak a 
forráskódokba kerül be, a wikiben túl távol lenne a kódtól, tuti, hogy a 
nem követné a kód változását (így sem mindig).

Sajnos persze ez nem mindig történik meg, gyakran rá lehet fogni arra, 
hogy épp kevés idő volt valamire, de azért inkább szintén az emberi 
tényezők döntenek, van aki fontosnak veszi, hogy szép kerek legyen a 
munkája, van aki nem annyira, inkább kötelező nyűg a dokumentálás. És 
valahogy képtelenek belátni az emberek, hogy a kódot lényegesen többszö 
olvassuk, mint írjuk, ezért olvasásra kéne optimalizálni, plusz gyakran 
megy el csomó idő arra, hogy kiderítsük, hogy ez meg az hogyan működik, 
csak valahogy ez természetes, míg az nem, hogy ezt meg lehetne úszni.


Üdv,
Felhő


További információk a(z) Javalist levelezőlistáról