core dokumentacia

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, Špecifikácia požiadaviek

Core vs Custom už na úrovni špecifikácie

/

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

Reálny problém z praxe

Na projekte sa rieši nová funkcionalita.

User story je zapísaná.
Špecifikácia vznikne.
Vývoj implementuje.

Po čase sa tester pýta:

„Prečo to funguje len u klienta XY?“
„Je to bug alebo feature?“
„Platí to pre všetkých alebo len pre jedného zákazníka?“…

Dokumentácia a používateľské príručky, User story a akceptačné kritériá

Core vs Custom už na úrovni user story

/

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

Reálny problém z praxe

Nový tester v projekte otvorí user story a vidí funkcionalitu, ktorá sa zdá byť súčasťou produktu.

Otestuje ju, napíše test case a pripraví poznámky do dokumentácie.

O niekoľko dní sa dozvie, že:

„To je špeciálna úprava pre klienta XY.“…

Dokumentácia a používateľské príručky, Úvod do dokumentácie

Ako to robiť v praxi: vrstvy dokumentácie

/

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

V predchádzajúcich článkoch sme pomenovali dva problémy:

  • vo firmách často neexistuje dokumentácia,
  • alebo existuje, ale mieša rôzne typy informácií.

Najčastejšie sa miešajú tieto veci:

  • štandardné funkcionality produktu
  • klientské úpravy
  • interné poznámky tímu
  • historické výnimky

Výsledok je jeden veľký dokument, ktorý síce existuje, ale nikto sa v ňom nevie orientovať.…

Dokumentácia a používateľské príručky, Úvod do dokumentácie

Core vs Custom: najväčší tichý problém dokumentácie v produktových firmách

/

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

V predchádzajúcich článkoch sme si ukázali dve veci:

  • prečo manuál nie je univerzálny dokument,
  • a čo sa deje vo firmách, kde dokumentácia neexistuje.

Teraz sa pozrime na problém, ktorý je menej viditeľný – ale v produktových firmách veľmi častý.…

Návrat hore