Séria: Ako písať dokumentáciu a manuály v IT projekte
Reálny problém z praxe
Manuál bol plný obrázkov.
Každý krok mal screenshot.
Šípky, krúžky, zvýraznenia.
Používateľ aj tak volal support:
„Ja to tam nemám.“
Ukázalo sa:
- tlačidlo bolo presunuté
- názov sa zmenil
- screenshot bol zo starej verzie
Používateľ nehľadal funkciu.
Hľadal obrázok.
Čo sa tu vlastne pokazilo (analýza systému)
Screenshot sa stal hlavným zdrojom informácie.
To je chyba.
Screenshot je:
- viazaný na konkrétnu verziu
- citlivý na každú UI zmenu
- bez kontextu často nepochopiteľný
Typické chyby:
- obrázok nahrádza text
- zvýraznenie bez vysvetlenia
- opis polohy namiesto významu
- manuál je len séria obrázkov
Používateľ potom:
- kopíruje obraz
- nerozumie kroku
- nevie sa prispôsobiť zmene
Skutočné náklady (čas, chaos, riziko)
- manuál zastaráva po každej zmene
- support rieši „nevidím to ako na obrázku“
- vznikajú falošné bugy
- údržba dokumentácie je náročná
A hlavne:
Používateľ prestáva veriť tomu, čo vidí.
Minimálny model riešenia
Screenshot je doplnok.
Nie základ.
1. Text musí fungovať aj bez obrázka
Používateľ musí vedieť:
- čo má spraviť
- kde to nájde (logicky, nie polohou)
- čo sa stane
Ak to nevie bez obrázka,
manuál nie je dostatočný.
2. Obrázok má mať konkrétny účel
Použi screenshot len vtedy, keď:
- UI nie je intuitívne
- orientácia je zložitá
- chceš potvrdiť, že používateľ je „na správnom mieste“
Nie preto, že „manuál má mať obrázky“.
3. Zvýraznenie musí mať význam
Zlé:
- červený krúžok bez textu
Používateľ nevie, čo to znamená.
Správne:
Klikni na „Export“ (označené na obrázku).
Funkcia slúži na stiahnutie dát do súboru.
4. Nepopisuj polohu, ale názov
Zlé:
Klikni na tlačidlo vpravo hore (viď obrázok).
Pri zmene UI to prestane fungovať.
Lepšie:
Klikni na „Export“ (pozri zvýraznenie na obrázku).
Používateľ hľadá názov, nie pozíciu.
5. Minimalizuj počet screenshotov
Viac obrázkov neznamená lepší manuál.
Naopak:
- zvyšuješ kognitívnu záťaž
- komplikuješ údržbu
- znižuješ prehľadnosť
Používaj len tie, ktoré majú hodnotu.
6. Aktualizuj kritické obrázky
Nie všetko musíš meniť.
Ale:
- screenshot viazaný na konkrétny krok → musí byť aktuálny
- orientačný obrázok → môže zostať
Rozlišuj medzi nimi.
Príklad (čo funguje vs čo nie)
Neefektívne:
- screenshot každej obrazovky
- bez vysvetlenia
- používateľ len kopíruje
Funguje:
Text:
- Otvor Fakturáciu
- Klikni na „Export“
Obrázok:
- zvýraznené tlačidlo
- dopĺňa orientáciu
Používateľ rozumie aj bez obrázka.
Obrázok len pomáha.
Mini checklist
- Je text pochopiteľný aj bez screenshotu?
- Má každý obrázok jasný účel?
- Je zvýraznenie vysvetlené?
- Nie je manuál preplnený obrázkami?
- Sú kritické screenshoty aktuálne?
Prepojenie na kvalitu a workflow
Screenshoty často odhalia problém:
- nejasné názvy prvkov
- zložitý workflow
- neintuitívne UI
Ak musíš každý krok vysvetľovať obrázkom,
možno problém nie je v manuáli, ale v systéme.
Krátke zhrnutie
Screenshot nie je dokumentácia.
Je to pomôcka.
Dobrý manuál:
- funguje aj bez obrázkov
- používa vizuály cielene
- vysvetľuje význam, nie len ukazuje obraz
Ak používateľ bez obrázka nevie, čo má spraviť,
manuál nie je dostatočne zrozumiteľný.