Dokumentácia v IT projekte: prečo vzniká neskoro a prečo je to problém


Prečo ľudia dokumentáciu neradi používajú

Skúsenosť väčšiny ľudí s dokumentáciou v IT projektoch je rovnaká: je to zdĺhavé, nudné a nikto to nečíta. A keď je dokumentácia robená ako povinná záverečná práca projektu, ktorú nikto nepýtal v priebehu práce, táto skúsenosť je oprávnená.

Problém však nie je v dokumentácii ako takej. Je v tom, ako a kedy dokumentácia vzniká.

Dokumentácia, ktorá vznikne na záver, aby sa splnila formalita, nemá hodnotu. Zachytáva stav veci, keď projekt skončil. Nie rozhodnutia, ktoré boli prijaté v jeho priebehu. Nie dôvody, prečo sme sa vybrali jedným smerom a nie druhým.

Čo sa stane bez nej

Na krátky čas sa zdá, že nič. Tím vie, čo robí. Každý si pamätá, o čom sa rozhodlo.

Potom nastúpi nový člen tímu. Alebo sa projekt obnoví po šiestich mesiacoch pauzy. Alebo príde audit. Alebo sa klient opýta, prečo sa konkrétne rozhodnutie prijalo tak, ako sa prijalo.

A zrazu sa ukáže, že kolektívna pamäť tímu má medzery. Každý si pamätá niečo iné. Niektoré rozhodnutia si nikto nepamätá vôbec.

V jednom medzinárodnom projekte, na ktorom som sa podieľala, sme strávili dva dni na workshope, kde sme rekonštruovali rozhodnutia z predchádzajúcej fázy. Dva dni, lebo nikto nezapísal, čo a prečo. To bol priamy náklad, ktorý sa dal eliminovať.

Čo nie je dobrá dokumentácia

100-stranový dokument plný tabuliek, diagramov a procesných schém, aktualizovaný naposledy pred rokom a pol, nie je dokumentácia. Je to archív.

Archív môže byť užitočný. Ale na každodenné potreby projektu je archív príliš pomalý a príliš vzdialený od toho, čo sa práve deje.

Dokumentácia nie je objem. Dokumentácia je relevantnosť. Dokument, ktorý odzrkadľuje dnešný stav projektu a zachytáva podstatné rozhodnutia, má väčšiu hodnotu ako desatnásobok strán, ktoré opisujú, ako veci mali fungovať pred rokom.

Čo je skutočne dobrá dokumentácia

Dobrá dokumentácia v IT projekte je krátka, priebežne udržiavaná a zameraná na rozhodnutia, nie na popis stavu.

Keď tím prijme rozhodnutie o architektúre systému, zapíše sa: čo sme sa rozhodli a prečo. Nie ako popis rozhodnutia, ale ako záznam kontextu, v ktorom vzniklo.

Keď sa zmení požiadavka, zapíše sa: čo sa zmenilo, kto to inicioval a aký bol dôvod. Nie rozsiahly dokument zmeny, ale krátky záznam.

Biznis analytik v tomto procese nie je sekretár, ktorý zapisuje za tím. Je to človek, ktorý rozumie tomu, čo je dôležité zachytiť, kde v dokumentácii to patrí a ako to formulovať, aby to bolo zrozumiteľné pre niekoho, kto prišiel neskôr.

Záver

Dokumentácia v IT projektoch má zlú povesť, lebo ľudia ju stotožňujú s objemom a povinnosťou. Keď sa od nej odtrhneme a pozrieme sa na to, čo dokumentácia naozaj má robiť, je to jednoduché: zachytiť rozhodnutia a ich dôvody, aby ich tím mohol použiť neskôr.

Koľko rozhodnutí z projektu, na ktorom pracujete, je niekde zapísaných? Nielen čo, ale aj prečo.

Ak vás zaujíma rola biznis analytika v IT projektoch, pozrite si kurz ITBA01 na academy.springbut.com.

Card image cap
Prečo začiatočníci v IT projektoch mlčia, keď by mali hovoriť

Väčšina ľudí, ktorí začínajú v IT projektoch, robí rovnakú chybu. Snažia sa rozumieť všetkému, ticho sledujú dianie okolo seba a otázky si nechávajú pre seba, aby nevyzerali nekompetentne. Práve toto ich spomaľuje a..

Card image cap
Čo robiť, keď zákazník nevie, čo chce

Predstavte si prvé stretnutie na projekte. Zákazník sa pohodlne oprie a povie: chcem, aby to bolo jednoduchšie. Nič viac. Vy sedíte s takmer prázdnym papierom a máte z tejto jednej vety postaviť softvér, ktorý bude niekto roky používať. Ak vás táto predstava desí, ste v dobrej spoločnosti. Patrí to medzi najčastejšie..

Card image cap
Možno v IT chýbate práve vy

Keď sa povie IT, veľa ľudí si automaticky predstaví programátora. Niekoho, kto sedí za počítačom, píše kód a rozumie veciam, ktoré bežný človek považuje za príliš technické. Lenže IT takto v praxi nefunguje. IT je ekosystém rôznych rolí. Sú..

Card image cap
Ako začať IT projekt bez paniky

Prvý deň v IT projekte. Nové tváre, skratky, ktorým nerozumieš, a v hlave jediná otázka: prečo si vybrali práve mňa? Tento pocit má meno. Volá sa impostor syndróm a v IT prostredí sa s ním stretáva prekvapivo veľa ľudí, vrátane tých skúsených. Problém nie je v tom, že..

Card image cap
Prvý deň v novom tíme: čo sa naozaj oplatí riešiť a čo nie

Väčšina ľudí nastupuje do nového zamestnania s rovnakou chybou. Buď sú tak vystrašení, že sa boja otvoriť ústa, alebo sú tak sebavedomí, že začnú poučovať kolegov skôr, ako pochopia, ako tam..