Používateľské manuály

Ako písať používateľské manuály

Dokumentácia a používateľské príručky, Používateľské manuály

Praktická ukážka ako napísať používateľský návod na 1 funkciu z user story+akceptačné kritériá a špecifikácie požiadavky+testovacie prípady

/

Séria: Ako písať dokumentáciu a manuály v IT projekte

Praktická ukážka

1. User story

Názov: Export faktúr do XML

User story:

Ako účtovník
chcem exportovať faktúry do XML
aby som ich mohol importovať do účtovného systému

 

2. Špecifikácia požiadavky

Popis funkcionality:

Systém umožňuje exportovať faktúry do XML súboru na základe zvoleného rozsahu dátumov.…

Dokumentácia a používateľské príručky, Používateľské manuály

Najčastejšie chyby v používateľských manuáloch a ich dopad na projekt (praktické ukážky)

/

Séria: Ako písať dokumentáciu a manuály v IT projekte

Reálny problém z praxe

Manuál existoval.

Bol „hotový“.
Bol odovzdaný.
Bol schválený.

A aj tak:

  • používatelia volali support
  • tester reportoval „bugy“
  • onboarding trval dlho

Keď som sa na to pozrela, nebol problém v tom, že by manuál chýbal.…

Dokumentácia a používateľské príručky, Používateľské manuály

Ako písať manuál pre rôzne úrovne používateľov (začiatočník vs pokročilý)

/

Séria: Ako písať dokumentáciu a manuály v IT projekte

 

Reálny problém z praxe

Manuál bol jeden.

Používali ho:

  • nový človek bez skúseností
  • skúsený používateľ, ktorý systém pozná roky

Výsledok:

  • začiatočník sa stratil po prvom kroku
  • pokročilý bol otrávený z „zbytočných vysvetlení“

Obaja mali pravdu.

Manuál nebol zlý.…

Dokumentácia a používateľské príručky, Používateľské manuály

Ako pracovať so screenshotmi a vizuálnymi prvkami v manuáli

/

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.…

Dokumentácia a používateľské príručky, Používateľské manuály

Univerzálna šablóna používateľského manuálu (core + custom vrstva)

/

Séria: Ako písať dokumentáciu a manuály v IT projekte

Reálny problém z praxe

Tím napíše manuál.

Pri prvej zmene funkcionality ho upraví.
Pri druhom klientovi ho rozšíri.
Pri treťom klientovi doplní výnimky.

Po čase:

  • rovnaká funkcionalita je opísaná na troch miestach
  • text si protirečí
  • nikto nevie, čo je vlastne štandard

A keď príde nový kolega:

„Platí toto pre všetkých?“…

Dokumentácia a používateľské príručky, Používateľské manuály

Ako písať používateľské manuály – príklady z praxe (čo funguje a čo nie)

/

Séria: Ako písať dokumentáciu a manuály v IT projekte

 

Reálny problém z praxe

Manuál existoval.
Bol „dobre napísaný“.

A aj tak:

  • používatelia volali support
  • tester sa pýtal na základné veci
  • nový kolega sa nevedel zorientovať

Keď som sa na to pozrela bližšie, problém nebol v tom, že by tam informácie neboli.…

Dokumentácia a používateľské príručky, Používateľské manuály

Ako písať používateľský manuál tak, aby odolal novým verziám

/

Séria: Ako písať dokumentáciu a manuály v IT projekte

Reálny problém z praxe

Vyšla nová verzia systému.

Funkcionalita sa nezmenila zásadne.
Len:

  • pribudlo tlačidlo
  • zmenil sa názov jedného poľa
  • presunul sa krok do inej časti obrazovky

Manuál bol zrazu nepoužiteľný.

Používateľ postupoval podľa neho a zasekol sa na kroku:
„Kliknite na tlačidlo Export vpravo hore.“…

Dokumentácia a používateľské príručky, Používateľské manuály

Ako písať používateľské manuály (aby ich ľudia naozaj čítali)

/

Séria: Ako písať dokumentáciu a manuály v IT projekte

 

Reálny problém z praxe

Manuál existoval. Mal 60 strán.

Používateľ zavolal support a pýtal sa:
„Kde nájdem export?“

Odpoveď bola na strane 42.

Lenže:

  • názov kapitoly bol „Dátové operácie“
  • text bol písaný technicky
  • nebol tam konkrétny scenár
  • screenshot bol zo starej verzie

Používateľ ten manuál nečítal.…

Návrat hore