Task: Správa uživatelské dokumentace

Cílem úlohy je vytvářet a spravovat dokumentaci k vyvíjenému produktu [Rojo, 2015]. Úlohu provádí primárně analytik, který má blíže k business zadavateli, zákazníkům a zároveň se vyzná i v technickém detailu aplikace [Crispin a Gregory, 2009]. Zásluhou toho analytik ví, komu je dokumentace určena a v jaké podrobnosti by měla být spravována. Vzhledem k tomu, že analytik má na starosti také správu požadavků a popisy jednotlivých funkcionalit, je pro následnou tvorbu a správu dokumentace tou nejvhodnější rolí.

Disciplines: Požadavky

Definice cílových uživatelů

Prvním krokem tvorby a následné správy produktové dokumentace je vymezení uživatelů, pro které má být určena. V případě, že se jedná o technicky zaměřené osoby, bude dokumentace o poznání podrobnější než v případě běžných uživatelů sužby.

Určení podrobnosti

Druhým krokem je určení podrobnosti, v jaké má být dokumentace spravována. Tento krok je přímo závislí na kroku 1 a dále na rozhodnutí vývojové týmu, resp. produktového vlastníka a zainteresovaných stran. Je například možné mít technickou verzi dokumentace, jejíž dílčí část je uživatelská příručka s návody a tutoriály pro běžné uživatele.

Výběr nástroje pro správu dokumentace

Třetím krokem je volba nástroje, ve kterém bude dokumentace vytvářena a zpravována. Může se jednat o jednoduchý textový dokument, dokument umožňující paralelní úpravu různých členů týmu či webovou stránku.

Vytvoření dokumentace

Dalším krokem je samotné vytvoření dokumentu s již definovaným členěním a strukturou v nástroji, který byl vybrán v předcházejícím kroku.

Publikace dokumentace

Publikace dokumentace cílovým uživatelům je hlavním cílem tvorby dokumentace. Je proto velmi důležité určit, v jakých cyklech bude dokumentace předávány koncovým uživatelům.

Aktualizace dokumentace

Aktualizace dokumentace je krok, který se opakuje v každé vývojové iteraci. Každá změna či nová funkcionalita, která má dopad na koncové uživatele, by měla být zanesena do dokumentace.