Kostolanský JurajAbstrakt. 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ú.Ogurčák FilipAbstrakt. Technická dokumentácia tvorí podstatnú, no častokrát zanedbávanú časť výsledného softvérového produktu. Zanedbávanú v tom zmysle, že pozornosť je kladená prevažne na funkcionalitu výsledného produktu, a na pravidelné aktualizovanie a dopĺňanie dokumentácie sa často zabúda. Dokumentácia však neslúži iba zákazníkom, ale je dôležitá aj pre programátorov, vedúcich vývojového tímu a manažment organizácie. V tejto eseji by som sa preto rád zameral na fakt, že aj keď dokumentácia nie je práve najaktuálnejšia, a nie sú v nej zapracované najnovšie zmeny, stále má dostatočnú prídavnú hodnotu pre zákazníka, programátora a manažéra kontrolujúceho nasledovanie projektu. Podstatný je v tomto prípade pohľad na vyvíjaný produkt ako celok, ale aj spôsob prepojenia jednotlivých modulov a znázornenie celkovej funkcionality. V konečnom dôsledku sa však do popredia dostáva neprítomnosť určitého štandardu, ktorý by proces tvorby technickej dokumentácie zjednotil a zjednodušil.
|