Close
TVORBA DOKUMENTÁCIE – RECEPT NA ÚSPECH V BOJI

TVORBA DOKUMENTÁCIE – RECEPT NA ÚSPECH V BOJI

Za ostatných 10 rokov som zažil veľa úspešných upgradov, prerábok a opráv siete. Bol som účastný ako technik – riešiteľ, manažér – iniciátor, pozorovateľ – užívateľ a hotline operátor – komunikátor.

Atmosféra a priebeh mi pripomína historickú bitku.  Príprava na akciu zahŕňa hodiny práce často týždne a mesiace plánovania, príprav, nákupu a konfigurácie vopred. Keď príde hodina H, Deň D napätie  sa dá krájať. Samotná bitka môže trvať iba niekoľko minút, no jej dôsledky môžeme cítiť ešte dlho po skončení- zmení históriu. Môže trvať aj podstatne dlhšie, niekedy práve pre neočakávané komplikácie sa predĺži boj niekoľko násobne.

Bitka sa môže strhnúť aj nečakane, bez prípravy a plánu, čo vôbec nemusí  znamenať prehru, naopak, niektoré nečakané  a rýchle bitky priniesli veľké výsledky. Výsledok bitky sa podobne ako v binárnej sústave preklopí do stavu výhra/prehra (1 alebo 0). Podstatný rozdiel pre víťaza sú straty -vynaložené náklady.  Pri bitke ide o vojakov, zbrane, vozidlá, budovy…. Pri novodobej bitke o lepšiu sieť sú nákladové straty- materiál, financie, zariadenia. Za najpodstatnejšiu považujem však čas. Ten môže mať fatálne následky – napríklad stratu klienta. Čo najviac pomáha skrátiť čas a minimalizovať náklady? Dobrý strategický plán a distribúcia informácie. Tak ako Alexandrovi Veľkému pomáhala presná mapa, nám pomáha dokumentácia.

Základné znaky dobrej dokumentácie

  • Štruktúra – prehľadnosť – ľudia sa často pýtajú prečo má mať dokumentácia formálne náležitosti ako napríklad hlavičku obsahujúcu informácie typu spracovateľ, riešiteľ, dátum… Prax ukazuje, že práve jednotná štruktúra pomáha a výrazne skracuje čas orientácie v dokumentoch. Spomeňte si na situáciu, kedy ste naposledy hľadali informáciu na stránke, ktorú nepoznáte/vidíte prvý krát. A  teraz si to skúste porovnať so stránkou, ktorú navštevujete pravidelne. Pointa – rovnaká (známa) štruktúra a rozdielne informácie – rýchla a presná orientácia.
  • Schéma zapojenia – nič technikovi nedá tak presný popis situácie ako dobre spracovaná schéma. Často sa ukazuje, že aj ceruzkou kreslená schéma kvalitnejšie objasní problematiku ako podrobný slovný popis. Týmto aspektom sa podrobnejšie zaoberá psychológia, v krátkosti ide o telefón efekt, každý človek má jemne inú interpretáciu slov, no schéma je presná a výstižná.
  • Fotodokumentácia – lepšie ako sto krát počuť je raz vidieť. Vizualizácia zariadení a priestoru veľmi pomáha z nepoznaného, nového. Človek sa cíti lepšie pripravený. Vďaka fotodokumentácii neostane na mieste v tak kritickú chvíľu prekvapený, nebodaj zaskočený.
  • Slovný popis – často prirovnávam k omáčke pri varení. Nemá byť majoritnou ingredienciou, je však veľmi dôležitá. Asi nikto z nás by nechcel jesť sviečkovú iba omáčku bez masa a knedle. Naopak bez omáčky to má svoju nutričnú hodnotu, ale nie správnu chuť. Podobne sa domnievam, že slovný popis by nemal presiahnuť 25% dokumentácie.
  • Kvantitatívne (exaktné) informácie – tabuľky, grafy, konfigurácia. Táto kategória je v technickom smere veľmi dôležitá. Často som bol svedkom školáckej chyby – snahy popísať všetky informácie slohovou prácou. Nie, to nie je a nikdy nebude na technickom oddelení správne. Keď raz má niečo presnú hodnotu, jediný ideálny spôsob je komunikovať presné číslo. Jednoduché príklady zo života: Slohová práca: auto ide veľmi rýchlo. To môže pre niekoho znamenať 130km/h a pre iného 230 km/h. Presná informácia: automobil sa pohybuje rýchlosťou 180 km/h.
  • Zmeny po realizácii a distribúcia informácií – dokumentáciu treba udržiavať aktuálnu a jej umiestnenie je strategicky dôležité. Odporúčam dobre zvoliť miesto prístupné každému, kto potrebuje informácie z dokumentácie k nahliadnutiu. Nie nadarmo sa hovorí, že posledné prikázanie administrátora je najdôležitejšie. *

Teda na záver krátka rekapitulácia receptu na dobrú dokumentáciu:

Hlavná  časť – mäso – schéma zapojenia, štruktúrované informácie typu grafy, tabuľky a príklady konfigurácie.  Odporúčam 50%.Príloha – Fotodokumentácia, ideálne so zakresleným popisom a vysvetlením. Odporúčané množstvo okolo 30%.Dobrá hustá omáčka – slovný opis pracovného postupu a zdôvodnenia projektu. Odporúčam nepresiahnuť 20%.Podávame na tanieri so zeleninovou oblohou pri každom jedle– štruktúrovaný dokument obsahujúci hlavičku a pätu.

Sto ľudí – sto chutí, preto každý si svoj recept musí nájsť sám. No pamätajte – tak ako pri jedle, lepšia nie úplne dokonalá dokumentácia ako žiadna. Fast food a hotfix nie je dobrý pričasto, aj keď sa mu občas nevyhneme. ;)

*https://blog.vnet.sk/10-prikazani-sietoveho-administratora-v-spolocnosti-vnet/

Pridaj komentár

Vaša e-mailová adresa nebude zverejnená. Vyžadované polia sú označené *

Close