Pod pokrievkou - diel prvý - Dokumentácia - mať či nemať, byť či nebyť, alebo prečo by software mal byť dokumentovaný.

Pod pokrievkou je nový seriál článkov, ktorý si kladie za cieľ poodhaľovať naše Know-how a ukázať, ako niektoré kľúčové záležitosti v NetDirecte riešime. V dnešnej téme sa venujeme tvorbe projektovej dokumentácie, jej významu a hrozbám vyplývajúcim z prehliadania jej potreby.

Na čo je vlastne projektová dokumentácia?

Dokumentácia je určená pre tím (programátori, analytici, testeri, databázoví špecialisti, administrátori), ktorý sa bude akýmkoľvek spôsobom so zákázkou "stretávať" v priebehu jej "života". Zákazník ju teda nepotrebuje, avšak mal by si overiť, podľa akých štandardov jeho dodávateľ v prípade tvorby dokumentácie postupuje. V softwarových firmách je totiž úplne bežné, že zákazku niekto iný tvorí a následne niekto iný spravuje, servisuje, či rozširuje. Priebežne udržovaná dokumentácia slúži na to, aby sa ktokoľvek s patričnými odbornými znalosťami v softwarovom diele zorientoval a mohol robiť kvalifikované zásahy.

Predstavte si projekt, do ktorého ste ako zákazník investovali svoje peniaze a tvorca (programátor) vášho dodávateľa opustil. Pokiaľ dodávateľ disponuje kvalitnou a aktuálnou dokumentáciou, je zaručené, že do rozbehnutého vlaku môže nastúpiť niekto iný. V prípade, že dokumentácia neexistuje, je neúplná alebo neaktuálna, čakajú vás iste bezsenné noci. Pravdepodobne budete musieť ďalším ľuďom znovu vysvetlovať, ako fungovali niektoré "temné" zákutia aplikácie, stratíte mnoho času i nervov, kedy jeden zásah v kóde ovplyvní chovanie ďalších častí programu, bez toho, aby to ktokoľvek dopredu tušil.

V čom sa malé firmy líšia od veľkých?

Rozdielov v prístupe k zákazkám malých a veľkých fiirem je celý rad. Práve prístup k projektovej dokumentácie často predstavuje zásadný, na prvý pohľad viditeľný rozdiel medzi prístupmi oboch pólov. Malé firmy sú často pod silným ekonomickým tlakom, potrebujú zákazku dokončiť za každú cenu a v čo najkratšom termíne, i bez ohľadu na kvalitu a budúcnosť, s ktorou si v danom okamžiku nelámu hlavu. Tvorba a aktualizácie dokumentácie je totiž časovo a finančne náročná, lenže jej podceňovanie je cestou do temných hlbín. V našej spoločnosti dokumentáciu považujeme za pilier budúcnosti, a preto jej tvorbe venujeme dostatok energie i ľudských zdrojov.

Životný cyklus aplikácie, alebo ako to riešime v NetDirecte

Aplikácie, či už ide o internetový obchod alebo redakčný systém pre tvorbu webových stránok a firemných portálov, prechádzajú v našej spoločnosti niekoľkými základnými etapami. Nad jednotlivými etapami držíme kontrolu vďaka vzájomne previazaným webovým aplikáciám, do ktorých majú prístup naši obchodníci, zamestnanci i zákazníci.

Špecifikátor - prvý stupeň tvorby dokumentácie

V Špecifikátorovi vznikajú štrukturované ponuky pre našich klientov. Prístup do neho majú obchodníci, analytici, account manažéri a ďalšie profesie, ktoré sa na jednotlivých zákazkách podielajú. Každé softwarové dielo je tu jednoznačne podchytené, obsahuje množinu zákazníkom zvolených modulov, špecifiká vyplývajúce z analýzy a podobne. Pred podpisom zmluvy sa zo Špecifikátora automaticky generuje technická špecifikácia riešení, ktorá slúži ako príloha zmluvy. Po uzavretí zmlouvy je pomocou Špecifikátoru riadený proces tvorby zákazky. Akonáhle je zákazka zákazníkom prevzatá do ostrej (produkčnej) prevádzky, predáva sa riadenie zákazky do ďalšej aplikácie zvanej HelpDesk. Obidve aplikácie sú však vzájomne prepojené.

Ukážka obrazovky aplikácie Špecifikátor. Tu konkretne modul riadenia výroby zákáziek.

HelpDesk - druhý stupeň tvorby dokumentácie

Webová aplikácia HelpDesk je dôverne známa všetkým našim klientom. Tí prostredníctvom HelpDesku nahlasujú prípadné chyby, žiadajú o kalkuláciu rôznych prác, čítajú informácie o novinkách v našich systémoch ShopCentrik a MediaCentrik. Zároveň tu zákazníci môžu sledovať priebeh servisných prác, pridelené ľudské zdroje (programátori, analytici, account manažéri) a získávajú celkový prehľad o riešení svojich požiadavkov (tiketov).

Ukážka aplikácie HelpDesk - klient získava absolutnú kontrolu nad
svojim projektom a môže si stanovovať priority riešenia tikeov.

Každý servisný zásah alebo rozšírenie funkčnosti je potom riešené ako tiket, kedy jeden tiket predstavuje jednu úlohu. Čaro pravidelne udržovanej dokumentácie začína práve tu, pretože pracovník riešiaci tiket jeho riešenie i vyriešenie viaže na konkrétny projekt a softwarový modul, ktorého sa riešenie týkalo. Vzniká tak kontinuálne a úplne automaticky udržovaná dokumentácia, ktorá sa viaže na technickú špecifikáciu prvého riešenia. Akýkoľvekv programátor sa potom rýchlo dokáže v softwarovom diele zorientovať a pokračovať v tímovej práci. Všetky procesy naviac korešpondujú s Integrovaným systémom kvality ČSN EN ISO 9001:2001 (Quality Management System) viac naša certifikácia.

Ukážka navigačného stromu projektovej dokumentácie.

Internetový obchod typu B2C a B2B - ukážka dokumentácie č. 1.

Internetový obchod typu B2C a B2B - ukážka dokumentácie č. 2.

Internetový obchod typu B2C a B2B - ukážka dokumentácie č. 3.

Internetový obchod typu B2C a B2B - ukážka dokumentácie č. 4.

Internetový obchod typu B2C a B2B - ukážka dokumentácie č. 5.