support manuál

Dokumentácia a používateľské príručky, Manuály pre technickú podporu

Praktické ukážky: 3–5 reálnych support scenárov (z user story + akceptačné kritériá + špecifikácia + bugy → hotové support položky)

/

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

 

Reálny problém z praxe

Tím má:

  • user story
  • akceptačné kritériá
  • špecifikáciu
  • bugy

Support má:

  • otázky od používateľov

Medzi tým nie je prepojenie.

Výsledok:

  • support nevie, čo systém robí
  • nevie, čo je chyba
  • nevie, čo je očakávané správanie

Dokumentácia existuje, ale nie je napojená na realitu.…

Dokumentácia a používateľské príručky, Manuály pre technickú podporu

Najčastejšie chyby v interný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

Firma má interné manuály.

Support ich otvorí.

Ale:

  • nenájde odpoveď
  • alebo nájde niečo neaktuálne
  • alebo nevie, či je to správne

A ide sa pýtať kolegu.

Dokumentácia existuje.
Ale nepoužíva sa.

 

Čo sa tu vlastne pokazilo (analýza systému)

Chyba nie je jedna.…

Dokumentácia a používateľské príručky, Manuály pre technickú podporu

Ako merať efektivitu support dokumentácie

/

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

 

Reálny problém z praxe

Firma má support dokumentáciu.

Má desiatky článkov.
Možno stovky.

Nikto však nevie:

  • či sa používa
  • či pomáha
  • či má zmysel

Dokumentácia existuje.

Ale jej hodnota je len pocit.

 

Čo sa tu vlastne pokazilo (analýza systému)

Dokumentácia sa nemeria.…

Dokumentácia a používateľské príručky, Manuály pre technickú podporu

Univerzálna šablóna support položky (ready-to-use pre prax)

/

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

 

Reálny problém z praxe

Support dokumentácia existuje.

Každý ju píše po svojom:

  • niekto opisuje funkcionalitu
  • niekto píše voľný text
  • niekto dá len pár bodov

Výsledok:

  • nedá sa v tom vyhľadávať
  • nedá sa to použiť konzistentne
  • každá odpoveď vyzerá inak

A hlavne:

rovnaké problémy sa riešia rôznymi spôsobmi.…

Dokumentácia a používateľské príručky, Manuály pre technickú podporu

Core vs Custom v support dokumentácii

/

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

Reálny problém z praxe

Support dostane otázku:

„Prečo u nás funguje export inak ako u iného klienta?“

Support nevie odpovedať.

Začne zisťovať:

  • je to bug?
  • je to konfigurácia?
  • je to nová funkcionalita?

Nakoniec sa ukáže:

  • ide o klientskú úpravu

Ale táto informácia:

  • nie je v dokumentácii
  • nie je označená
  • existuje len „v hlave“

Čo sa tu vlastne pokazilo (analýza systému)

Dokumentácia nerozlišuje:

  • čo je Core (štandard produktu)
  • čo je Custom (klientská úprava)

Všetko je zmiešané.…

Dokumentácia a používateľské príručky, Manuály pre technickú podporu

Ako písať symptómovo, nie funkčne

/

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

 

Reálny problém z praxe

Support dostane otázku:

„Prečo sa mi nevytvorila faktúra?“

Otvorí dokumentáciu a nájde:

„Modul Fakturácia umožňuje vytvárať, upravovať a exportovať faktúry…“

To je síce pravda.
Ale nepomáha to vyriešiť problém.

Support nevie:

  • čo sa pokazilo
  • kde to hľadať
  • čo má skontrolovať

A ide sa pýtať seniora.…

Dokumentácia a používateľské príručky, Manuály pre technickú podporu

Štruktúra jednej support položky (Symptóm → Príčina → Diagnostika → Riešenie)

/

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

 

Reálny problém z praxe

Support dostane ticket:

„Používateľ sa nevie prihlásiť.“

Začne sa klasické kolečko:

  • „Aký má login?“
  • „Aká je chyba?“
  • „Funguje to iným?“
  • „Čo sa menilo?“

Každý rieši rovnaké otázky stále dokola.

A dokumentácia?

Buď neexistuje, alebo obsahuje kapitolu:

„Prihlásenie do systému umožňuje…“

To supportu nepomôže.…

Dokumentácia a používateľské príručky, Manuály pre technickú podporu

Support manuál ≠ používateľský manuál

/

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

 

Reálny problém z praxe

Používateľ napíše na support:

„Nejde mi export faktúry.“

Support otvorí dokumentáciu. Nájde kapitolu:

„Export faktúr umožňuje exportovať dáta do XML formátu…“

Žiadna zmienka o chybe.
Žiadny postup, čo skontrolovať.
Žiadne príklady chýb.…

Návrat hore