Pod pokličkou - díl první - Dokumentace - mít či nemít, být či nebýt, aneb proč by software měl být dokumentován.

Pod pokličkou je nový seriál článků, který si klade za cíl poodhalovat naše Know-how a ukázat, jak některé klíčové záležitosti v NetDirectu řešíme. V dnešním tématu se věnujeme tvorbě projektové dokumentace, jejímu významu a hrozbám vyplývajícím z přehlížení její potřeby.

K čemu je vlastně projektová dokumentace?

Dokumentace je určena pro tým (programátoři, analytici, testeři, databázoví specialisté, administrátoři), jež se bude jakýmkoliv způsobem se zakázkou "potkávat" v průběhu jejího "života". Zákazník ji tedy nepotřebuje, avšak měl by si ověřit, podle jakých standardů jeho dodavatel v případě tvorby dokumentace postupuje. V softwarových firmách je totiž naprosto běžné, že zakázku někdo jiný tvoří a následně někdo jiný spravuje, servisuje, či rozšiřuje. Průběžně udržovaná dokumentace slouží k tomu, aby se kdokoliv, byť s patřičnými odbornými znalostmi v softwarovém díle zorientoval a mohl provádět kvalifikované zásahy.

Představte si projekt, do kterého jste jako zákazník investovali své peníze a tvůrce (programátor) vašeho dodavatele opustil. Pokud dodavatel disponuje kvalitní a aktuální dokumentací, je zaručeno, že do rozjetého vlaku může nastoupit někdo jiný. V případě, že dokumentace neexistuje, je neúplná nebo neaktuální, čekají vás jistě bezesné noci. Pravděpodobně budete muset dalším lidem znovu vysvětlovat jak fungovala některá "temná" zákoutí aplikace, ztratíte mnoho času i nervů, kdy jeden zásah v kódu ovlivní chování dalších částí programu, aniž by to kdokoliv dopředu tušil.

Rozdílů v přístupu k zakázkám malých a velkých firem je celá řada. Právě přístup k projektové dokumentaci často představuje zásadní, na první pohled viditelný rozdíl mezi přístupy obou pólů. Malé firmy jsou často pod drtivým ekonomickým tlakem, potřebují zakázku dokončit za každou cenu a v co nejkratším termínu, i bez ohledu na kvalitu a budoucnost, se kterými si v daném okamžiku nelámou hlavu. Tvorba a aktualizace dokumentace je totiž časově a finančně náročná, jenže její podceňování je cestou do temných hlubin. V naší společnosti dokumentaci považujeme za pilíř budoucnosti, a proto její tvorbě věnujeme dostatek energie i lidských zdrojů.

Životní cyklus aplikace, aneb jak to řešíme v NetDirectu

Aplikace, ať už se jedná o internetový obchod nebo redakční systém pro tvorbu webových stránek a firemních portálů, prochází v naší společnosti několika základními etapami. Nad jednotlivými etapami držíme kontrolu díky vzájemně provázaným webovým aplikacím, do kterých mají přístup naši obchodníci, zaměstnanci i zákazníci.

Specifikátor - první stupeň tvorby dokumentace

Ve Specifikátoru vznikají strukturované nabídky pro naše klienty. Přístup do něj mají obchodníci, analytici, account manažeři a další profese, jež se na jednotlivých zakázkách podílejí. Každé softwarové dílo je zde jednoznačně podchyceno, obsahuje množinu zákazníkem zvolených modulů, specifika vyplývající z analýzy a podobně. Před podpisem smlouvy se ze Specifikátoru automaticky generuje technická specifikace řešení, jež slouží jako příloha smlouvy. Po uzavření smlouvy je pomocí Specifikátoru řízen proces tvorby zakázky. Jakmile je zakázka zákazníkem převzata do ostrého (produkčního) provozu, předává se řízení zakázky do další aplikace zvané HelpDesk. Obě aplikace jsou však vzájemně propojeny.

Ukázka obrazovky aplikace Specifikátor. Zde konkrétně modul řízení výroby zakázek.
Ukázka obrazovky aplikace Specifikátor. Zde konkrétně modul řízení výroby zakázek.

HelpDesk - druhý stupeň tvorby dokumentace

Webová aplikace HelpDesk je důvěrně známa všem našim klientům. Ti jejím prostřednictvím nahlašují případné chyby, žádají o kalkulace různých prací, čtou informace o novinkách v našich systémech ShopCentrikMediaCentrik. Zároveň zde zákazníci mohou sledovat průběh servisních prací, přidělené lidské zdroje (programátoři, analytici, account manažeři) a získávají celkový přehled o řešení svých požadavků (tiketů).

Ukázka aplikace HelpDesk.
Ukázka aplikace HelpDesk - klient získává absolutní kontrolu nad
svým projektem a může si stanovovat priority řešení tiketů.

Každý servisní zásah nebo rozšíření funkčnosti je pak řešeno jako tiket, kdy jeden tiket představuje jeden úkon. Kouzlo pravidelně udržované dokumentace začíná právě zde, protože pracovník řešící tiket, jeho řešení i vyřešení váže na konkrétní projekt a softwarový modul, jehož se řešení týkalo. Vzniká tak kontinuálně a zcela automaticky udržovaná dokumentace, která se váže na technickou specifikaci prvotního řešení. Jakýkoliv programátor se pak rychle dokáže v softwarovém díle zorientovat a pokračovat v týmové práci. Věškeré procesy navíc korespondují s Integrovaným systémem jakosti ČSN EN ISO 9001:2001 (Quality Management System).

Ukázka navigačního stromu projektové dokumentace.
Ukázka navigačního stromu projektové dokumentace.

Internetový obchod typu B2C a B2B - ukázka dokumentace č. 1.
Internetový obchod typu B2CB2B - ukázka dokumentace č. 1.

Internetový obchod typu B2C a B2B - ukázka dokumentace č. 2.
Internetový obchod typu B2C a B2B - ukázka dokumentace č. 2.

Internetový obchod typu B2C a B2B - ukázka dokumentace č. 3.
Internetový obchod typu B2C a B2B - ukázka dokumentace č. 3.

Internetový obchod typu B2C a B2B - ukázka dokumentace č. 4.
Internetový obchod typu B2C a B2B - ukázka dokumentace č. 4.

Internetový obchod typu B2C a B2B - ukázka dokumentace č. 5.