Zbierka esejí 2013
Home Home EN
"dokumentácia"
Dušek Martin

Abstrakt. Ku každému cieľu môže viesť viac ciest. Dnešná spoločnosť je celá riadená rôznymi softvérmi, informačnými systémami či technológiami, ktoré nám pomáhajú robiť veci efektívnejšie, rýchlejšie a kvalitnejšie. Aj pri písaní dokumentácií k softvérovým produktom treba pristupovať inovatívne a snažiť sa robiť to lepšie. Najväčší trend v písaní dokumentácie je použitie systému pre online dokumentáciu formou Wiki. V tejto eseji sa môžete dočítať niečo o tejto metóde, jej histórii, budúcnosti, výhodách, nevýhodách a o mojom názore ako ich môžeme riešiť. Ako písať dokumentáciu, je však ešte len prvý krok k jej napísaniu. Musíme vedieť, čo reálne potrebujeme v dokumentácii. Ja si myslím, že potrebujeme písať len to, čo ľudia reálne potrebujú a nie viac, ani menej.


Kostolanský Juraj

Abstrakt. Technická dokumentácia, používateľská príručka, komentáre zdrojového kódu. Hoci sa dnes dokumentácia považuje za neoddeliteľnú súčasť sofvérového produktu, často sa jej tvorbe venuje oveľa menšie úsilie, než by si zaslúžila. Napriek tomu, že kvalitná dokumentácia vedie nielen k spokojnejším zákazníkom, jednoduchšiemu zorientovaniu sa v zdrojovom kóde pre programátora, ale aj k úspore času a nemalých finančných prostriedkov, stále je považovaná skôr za nevyhnutné zlo než za spôsob zjednodušenia si práce a skvalitnenia výsledného produktu. V tejto eseji sa zameriavam na potrebu dokumentovania softvéru z viacerých pohľadov, zamýšlam sa nad pojmom kvalita v kontexte dokumentovania a opisujem základné chyby, ktorých sa tvorcovia dokumentácie dopúšťajú.


Láni Marek

Abstrakt. S problémami spojenými s nedostatočnou dokumentáciou, sa počas života stretne zrejme 99% programátorov ak nie všetci. Treba povedať, že tvorba dokumentácie nepatrí k náročným procesom vývoja softvéru, avšak tento proces sa všeobecne nestretá s obľubou. Dokonca aj moderné prístupy k vývoju softvéru venujú dôležitosti jej tvorby málo pozornosti. Takýmto prístupom je aj agilný vývoj. Ten sa riadi heslom: "Dobre pracujúci softvér nad dokumentáciu" a na otázku koľko dokumentácie je potrebné odpovedá: "Akurát". V eseji však na príkladoch z praxe ukážeme, že dokumentácia je veľmi dôležitou súčasťou projektu a, že sú prípady, kedy sa dobre pracujúci softvér bez nej nezaobíde. Rovnako sa pokúsime definovať, koľko je "akurát" dokumentácie a budeme diskutovať vzory tvorby dokumentácie, týkajúce sa agilného vývoja. Týmito vzormi sú Nepravá dokumentácia, Časové značky, Projektový slovník, Elektronické zálohovanie a Zreteľná aktivita. Ku každému z týchto vzorov uvedieme príklad kedy a za akých okolností je vytváranie daného typu dokumentácie výhodné a akým problémom nám pomôže sa vyvarovať. Rovnako poskytneme ku týmto spôsobom možné vylepšenia, prípadne načrtneme negatíva alebo pozitíva jednotlivých riešení.


Lekeň Tomáš

Abstrakt. Súčasťou každého softvérového produktu je dokumentácia najrôznejších druhov. Bežný používateľ, ktorý nie je technicky zdatný, prichádza najviac do styku s používateľskou príručkou. Práve preto by mali byť kladené najvyššie nároky na jej čitateľnosť a zrozumiteľnosť. K zrozumiteľnosti veľkou mierou prispievajú aj nové formy dokumentácie, akou sú napríklad video tutoriály, ktoré umožňujú jednoducho predviesť používanie vybranej funkcionality. Esej sa sústreďuje na problematiku čitateľnosti a jednoduchosti vytváranej dokumentácie.


Škoda Matej

Abstrakt. Pri agilných metódach vývoja softvéru sa často prisudzuje dokumentácií nízka priorita a je zanedbávaná. Často je vývojármi chápaná ako zbytočnosť. Výsledkom dokumentovania je často nedostatočne použiteľný dokument. Táto esej pojednáva o problémoch ako je slabá kvalita dokumentácie, jej umelé vytváranie alebo vytváranie príliš neskoro. Popisuje názory vedúcich členov tímov na jej tvorbu pri agilných spôsoboch vývoja softvéru a jej dôležitosť pre softvérové projekty. Ďalej sa venuje popisu procesu tvorby dokumentácie pri agilných metodikách vývoja softvéru. Snaží sa navrhnúť aspoň čiastočné riešenia tohto problému napríklad využitím kombinácie agilných a klasických tímov na tvorbu dokumentácie. V krátkosti sa tiež vyjadruje k ďalšiemu používanému spôsobu tvorby dokumentácie a to jej automatizované generovanie.


Left Separator
plán rozvrh komunikácia softvérový projekt tím monitorovanie agilný vývoj zákazník riziká riziko Scrum plánovanie manažment rizík manažment verzií manažment nevýhody kvalita softvér extrémne programovanie párové programovanie motivácia úspech podporné prostriedky správa verzií manažment kvality dokumentácia agilné metódy vývoj softvéru úlohy softvérové metriky tímový projekt manažment dokumentácie projekt metriky vodopádový model manuál príručka podpora vývoja malé tímy použiteľnosť testovanie kvalita softvéru podporné nástroje manažment podpory vývoja konfigurácia softvéru kontrola kvality verziovací systém efektívnosť agilné metódy vývoja