Pomáham firmám vytvárať dokumentáciu, znalostné bázy a testovacie podklady, podľa ktorých sa dá skutočne pracovať. Mojím cieľom nie je vyrobiť čo najviac textu, ale znížiť čas strávený hľadaním informácií, opakovanými otázkami, nejasnými zadaniami a riešením tých istých problémov.
Rozsah práce prispôsobím veľkosti projektu a tomu, čo už vo firme existuje. Môže ísť o jeden návod, kontrolu existujúcej dokumentácie, vytvorenie jej štruktúry alebo postupné nastavenie celého dokumentačného procesu.
Tvorba a úprava dokumentácie
Používateľské manuály
- návody postavené na úlohách, ktoré používateľ reálne vykonáva,
- zrozumiteľné postupy krok za krokom,
- vysvetlenie podmienok, výnimiek, obmedzení a očakávaného výsledku,
- zmysluplné používanie obrázkov a snímok obrazovky,
- úprava starších manuálov po zmenách v aplikácii,
- oddelenie spoločnej funkcionality od zákazníckych úprav.
Administrátorské a interné príručky
- roly, oprávnenia, konfigurácia a ich dopady,
- bežné prevádzkové úlohy,
- nasadenie, aktualizácia a kontrolné kroky,
- riešenie incidentov a známych problémov,
- diagnostické postupy a eskalácia,
- návody pre zákaznícku a technickú podporu.
Technická a prevádzková dokumentácia
- prehľad systému, modulov a ich väzieb,
- popis integrácií, dátových tokov a externých závislostí,
- databázové poznámky, dátový slovník a význam dôležitých polí,
- API postupy a praktické príklady,
- release a deployment checklisty,
- evidencia skriptov, konfigurácií, obmedzení a známych rizík.
Technickú dokumentáciu tvorím podľa dostupných podkladov a v spolupráci s ľuďmi, ktorí systém poznajú. Ak podklady chýbajú, pomôžem znalosti získať rozhovormi, skúšaním aplikácie a overením výsledkov. Nenahrádzam však architekta ani vývojára tam, kde je potrebné ich odborné rozhodnutie.
Kontrola a audit existujúcej dokumentácie
Prejdem dostupné manuály, internú wiki, návody, release notes a súvisiace pracovné postupy. Výsledkom môže byť:
- zoznam chýbajúcich, neaktuálnych alebo duplicitných informácií,
- posúdenie, či sa podľa dokumentácie dá vykonať opisovaný postup,
- kontrola súladu dokumentácie so skutočným správaním aplikácie,
- návrh cieľových skupín a potrebných typov dokumentácie,
- odporúčaná štruktúra a priority úprav,
- návrh pravidiel pre vlastníctvo, aktualizáciu, verziovanie a archiváciu,
- zoznam rýchlych opráv s najväčším praktickým prínosom.
Dokumentáciu viem overiť aj ako testerka: postup vykonám podľa návodu, porovnám výsledok s aplikáciou a označím miesta, kde chýba krok, podmienka, očakávaný výsledok alebo dôležité upozornenie.
Interná znalostná báza
Pomôžem premeniť roztrúsené poznámky, e-maily a opakované odpovede na prehľadnú znalostnú bázu v Confluence alebo inom používanom nástroji.
Súčasťou práce môže byť:
- návrh informačnej architektúry a navigácie,
- rozdelenie obsahu podľa cieľových skupín,
- pravidlá názvov, značiek a vyhľadateľnosti,
- šablóny pre návody, incidenty, FAQ a technické poznámky,
- zápis riešení v štruktúre symptóm, príčina, diagnostika a riešenie,
- odstránenie duplicít a označenie neplatných postupov,
- návrh procesu, v ktorom sa nový poznatok priebežne dostane do znalostnej bázy.
Dokumentácia ako súčasť pracovného procesu
Samotné založenie wiki nestačí. Ak dokumentácia nemá vlastníka, miesto vo workflow a čas na aktualizáciu, postupne zastará.
Pomôžem pripraviť jednoduché pravidlá pre:
- vznik dokumentácie spolu s novou funkciou,
- prepojenie požiadavky, testov, manuálu a release notes,
- kontrolu dokumentácie pred vydaním verzie,
- Definition of Ready a Definition of Done primerané spôsobu práce tímu,
- zodpovednosť za odborný obsah, úpravu a schválenie,
- pravidelnú kontrolu aktuálnosti,
- archiváciu zastaraných verzií,
- zachytenie znalostí pri odchode alebo zmene roly kolegu.
Tieto princípy sa dajú použiť v agilnom aj klasickom projektovom riadení. Cieľom nie je zaviesť metodiku navyše, ale odstrániť konkrétne straty času a informácií.
Podklady pre zaúčanie nového kolegu
Pripravím alebo pomôžem usporiadať odbornú časť onboardingu pre konkrétnu rolu. Môže obsahovať:
- plán prvého dňa, týždňa a mesiaca,
- zoznam potrebných prístupov, nástrojov a kontaktov,
- základný kontext produktu a pracovných procesov,
- poradie tém od nevyhnutných základov po samostatné úlohy,
- praktické cvičenia na reálnych pracovných situáciách,
- checklist pre nového kolegu a mentora,
- zoznam častých otázok a typických chýb,
- spôsob priebežného overenia, či nový kolega rozumie práci a dokáže ju vykonávať samostatne.
Nejde o všeobecnú personalistiku. Zameriavam sa na odovzdanie pracovných znalostí, zástupnosť a zníženie závislosti od jediného skúseného človeka.
Analýza požiadaviek a testovateľnosti
Nejasné zadanie spôsobí, že zadávateľ, vývojár a tester si predstavia tri rozdielne riešenia. Pomôžem preto s praktickou kontrolou podkladov pred vývojom:
- ujasnenie cieľa a používateľského problému,
- odhalenie chýbajúcich podmienok, výnimiek a hraničných situácií,
- kontrola testovateľnosti požiadaviek,
- úprava akceptačných kritérií,
- kontrola väzieb na existujúce funkcie, roly a dáta,
- príprava podkladov pre testy, manuál a release notes.
Testovacia analýza a manuálne testovanie
- návrh testovacieho prístupu podľa rizík projektu,
- smoke a regresné scenáre,
- testovacie prípady pre bežné, hraničné a chybové situácie,
- funkčné testovanie webových a desktopových aplikácií,
- kontrola údajov medzi používateľským rozhraním a databázou,
- testovanie API v Postmane a overenie výsledku v aplikácii,
- testovanie integrácií, exportov, PDF, notifikácií a tlačových výstupov,
- zrozumiteľné bug reporty s krokmi, dôkazmi a dopadom,
- kontrola súladu aplikácie, zadania a dokumentácie.
Podľa potrieb projektu viem pripraviť aj jednoduché automatizované kontroly v Pythone a Selenium. Automatizáciu odporúčam tam, kde prináša opakovateľný úžitok a jej údržba nebude drahšia než samotné manuálne overenie.
Jira, Xray a Confluence
Pomôžem s praktickým nastavením pracovného priestoru pre menší tím alebo projekt:
- štruktúra projektov, typy úloh a základné workflow,
- evidencia požiadaviek, úloh, chýb a testov,
- Xray pre testovacie scenáre, test execution a regresné sady,
- filtre, dashboardy a pravidelné prehľady,
- jednoduché automatizácie nadväzujúcich úloh,
- zákaznícky portál a presun komunikácie z neprehľadných e-mailov do evidovaných požiadaviek,
- prepojenie Jiry s dokumentáciou v Confluence.
Rozsiahlu administráciu podnikovej Atlassian infraštruktúry, bezpečnostnú architektúru ani zložité integrácie neponúkam ako samostatnú špecializovanú službu. Viem však navrhnúť a nastaviť praktický proces v rozsahu, s ktorým mám skúsenosti, a pomenovať oblasti, kde treba zapojiť špecialistu.
Ako spolupráca začne
Na úvod potrebujem vedieť:
- čo firma alebo tím rieši,
- kto bude výsledok používať,
- aké podklady už existujú,
- kde dnes vznikajú chyby, zdržanie alebo opakované otázky,
- čo má byť po skončení spolupráce jednoduchšie než dnes.
Po úvodnom oboznámení navrhnem primeraný rozsah, priority a konkrétny výstup. Pri menšej úlohe to môže byť upravený návod alebo checklist. Pri väčšej práci najskôr pripravím audit a návrh štruktúry, aby sa zbytočne neprepisovalo niečo, čo tím nebude vedieť udržiavať.
Ak potrebujete manuál, internú znalostnú bázu, testovacie podklady alebo praktickejší spôsob odovzdávania znalostí, ozvite sa mi.