Tvorba dokumentácie

Kvalitná dokumentácia je potrebná pre väčšie a zložitejšie internetové portály, služby a aplikácie. Je nevyhnutná z dôvodu produktivity a účelnosti jej ďalšieho využívania. Predovšetkým je potrebná pre budúce dopracovávanie, prepojenie nových modulov či iných služieb. Detailne obsahuje všetky potrebné informácie tak pre koncového klienta, ktorý aplikáciu má používať alebo prevádzkovať ako aj pre kóderov pracujúcich na funkcionalite.

Pri tvorbe dokumentácie okrem iného využívam znalosti z prípravy dokumentácie k odovzdaným programom počas štúdia na vysokej škole.

Obsah jednotlivých časti príručiek je zvolený vždy podľa jeho dôležitosti a opodstatnenosti.

V prípade, že je to dôležité (a to predovšetkým pre internetový marketing) súčasťou konceptu je aj príloha analýzy súčasného stavu, porovnania konkurencie a názory, spätná väzba či pripomienkovanie a komentáre od mnou oslovených ľudí, ktorým bol predstavený navrhovaný budúci projekt.

Súčasťou analýzy projektu je: zadanie úlohy, analýza systému, technické riešenie, časový a cenový odhad, popis metódy (teoretický princíp) CoCoMo, odhad na základe základného modelu, odhad na základe stredného modelu, časový rozvrh prác, model požiadaviek, návrh – model celého systému, model systému, aktéri, diagramy prípadov použitia, objektový model, model interakcie objektov, dátové modely, model implementovaného podsystému.

Koncept obsahuje: Ganttov diagram, document view, user allocation view, traceability view, use case modely, sekvenčné diagramy, stavový diagram, konceptuálny dátový model, fyzický dátový model

Táto príručka má za úlohu pomôcť klientovi zoznámiť sa a naučiť sa pracovať s aplikáciou.

Súčasťou používateľskej príručky je: analýza riešenia, popis aplikácie, obsluha aplikácie, screenshoty podstránok a vysvetlenie používania s popísaním funkcionality, popísanie rozhraní systému (používateľské, administrátorské), inštalácia a preklad programu, náväznosť na iné programové produkty.

Koncept obsahuje: use case modely, screenshoty

Príručka zohľadňuje modularitu internetovej aplikácie ako aj modularitu na úrovni aplikovaných služieb, čo umožňuje rozširovanie týchto prvkov a teda otvára priestor pre doplnkové služby bežne využívané a vhodné. Vďaka prehľadnej systémovej príručke je možné efektívne realizovať budúce požiadavky, aby sa mohla doprogramovať istá funkčnosť, doplniť modul a používať ho.

Súčasťou systémovej príručky je: funkcia aplikácie, charakteristika aplikácie, modely prípadov použitia, diagramy dátových tokov, dátový model, popis  algoritmov a údajových štruktúr, globálnych premenných, popis modulov a podprogramov, preklad programu, zoznam zdrojových kódov, požiadavky na technické prostriedky pri preklade, požiadavky na programové prostriedky pri preklade, vlastný preklad, náväznosť na iné programové produkty (framework, programovacie techniky), chybové hlásenia,

Koncept obsahuje: Ganttov diagram, modely na podsystémy, requirement model

Zdrojové kódy sú zriedkavou prílohou k celkovej dokumentácii za predpokladu, že ide o finálnu verziu s potrebou zoznámenia sa s ňou pre všetkých budúcich kóderov. Je účelná pri modulárnom systéme vyvíjaného na základe objektového programovania.

Súčasťou zdrojových kódov sú: deklarácie funkcií, tried, plné zdrojové kódy, katalóg tried

Dôležitá správa z prvého testovania pred ostrým spustením internetovej aplikácie. Záznam z tohto testovania je dôležitý pre opätovné testovanie funkcionality vždy po zásadnom doprogramovávaní aby sa vylúčilo zlyhanie už fungujúcej funkcionality.

Súčasťou záznamu z testovania je: správa prístupov, autentizácia, overenie funkcionality, a ostatné súčasti