Analytická dokumentace¶

Úvod¶

Tato kapitola zavádí Analytickou dokumentaci jako celek toho, co analytik na projektu vytvoří a odevzdá, a Požadavky jako jednu z jejích tří oblastí.

Kapitola odpovídá na otázku, co do analytické práce patří a co ne. Neodpovídá na otázku, jak podrobný je popis; to říká osa Úrovně abstrakce. Jsou to dvě různá vymezení a snadno se pletou.

Analytická dokumentace¶

Analytická dokumentace je celek toho, co analytik na projektu vytvoří a odevzdá, aby se dal systém postavit.

Skládá se ze tří oblastí: Požadavky, HLA a LLA. Vzniká jako celek a jako celek se také udržuje; oblasti nejsou tři samostatné dokumenty, které by mohly žít každý po svém.

Všechny tři se týkají téhož systému, ale nepopisují totéž z různých úhlů. Požadavky drží podklady, ze kterých se vychází. HLA popisuje okolí v kontextu dějů, při nichž se systém použije. LLA popisuje chování a evidenci uvnitř systému, v přímé návaznosti na HLA.

Oblasti si musí navzájem odpovídat. To je podmínka, ne doporučení: analytická dokumentace, ve které jedna oblast neodpovídá druhé, není hotová, i kdyby byla každá oblast sama o sobě úplná. Právě proto se dělají a udržují společně a proto je žádná z nich nenahraditelná. Bez podkladů není proti čemu měřit, co má systém splnit. Bez popisu okolí není odkud určit, kde se systém použije. Bez popisu vnitřku není řečeno, co se má dít po použití.

Jak se soulad udržuje a kontroluje, popisují Stroj konzistence AAF, Udržení konzistence UCM, Zákon zachování informace a Analysis Review.

Tři oblasti¶

Požadavky drží podklady, ze kterých analytická práce vychází. Je to první oblast, která na projektu vzniká, a zbylé dvě z ní čerpají. Viz sekce níže.

HLA popisuje okolí v kontextu dějů, při nichž se systém použije. Z toho popisu analytik vyčte, kde systém vstupuje do hry. Viz kapitola Vrstvy HLA a LLA.

LLA popisuje chování a evidenci uvnitř systému, v přímé návaznosti na HLA. Odpovídá hodnotě Analytický model IS na ose Úrovně abstrakce.

Oblasti nejsou členěné podle téhož kritéria a nejsou to stupně podrobnosti. HLA a LLA se neliší tím, jak jsou podrobné, ale tím, co popisují a jak na sebe navazují. Požadavky jsou dány fází, ve které vznikají. Není to tedy osa a nemá smysl hledat, která oblast je vyšší.

Rozlišující znaky¶

Odevzdává analytik. Je to výsledek analytické práce, ne sběr všeho, co se na projektu urodilo.
Vzájemná odpovídavost. Oblasti si musí odpovídat. Úplnost každé z nich zvlášť nestačí.
Nenahraditelnost. Žádná oblast nemůže chybět a žádná nemůže suplovat jinou.
Celek, ne tři dokumenty. Oblasti se udržují společně; změna v jedné se promítá do ostatních.
Není to osa. Oblasti nejsou stupně podrobnosti a nedají se seřadit. Podrobnost popisu řeší Úrovně abstrakce.

Hranicí je evidence, ne autorství¶

O tom, zda věc do Analytické dokumentace patří, nerozhoduje, kdo ji vytvořil, ale zda je v evidenci.

Mail od zadavatele je řeč a je venku. Týž mail umístěný na dohodnutou pozici je evidovaná Zadávací dokumentace a patří dovnitř, přesně tak jako Funkční požadavek, který z něj vznikne. Že jeden vznikl u zadavatele a druhý u analytika, je informace o původu, ne o příslušnosti.

Je to týž vztah jako mezi papírovou fakturou na stole a evidovanou fakturou. Nikoho nenapadne říct, že evidovaná faktura do systému nepatří, protože ji vystavil někdo jiný. Podrobněji viz Zrcadlení pojmů.

Co do Analytické dokumentace nepatří¶

Na projektu vzniká i to, co analytickou prací není. Logo, barevné schéma, inzeráty, obchodní podmínky, ceník, školení uživatelů. Všechno to má v projektu svého majitele, jen tím majitelem není analytik.

Test: potřebuje to analytik k tomu, aby určil nebo popsal, co a jak systém dělá?

Popis okolí potřebuje, protože z něj vyčte body použití systému, a proto je HLA uvnitř. Tvar loga nepotřebuje, a to ani tehdy, když je pro projekt důležitý. Nevyplývá z něj žádný Use Case, žádný proces ani žádná třída.

Vyloučení není hodnotící soud. Neříká, že logo je nepodstatné, ale že se nedělá tady.

Požadavky¶

Požadavky jsou oblast Analytické dokumentace, která drží podklady, ze kterých analytická práce vychází.

Obsahuje šest pojmů: Zadávací dokumentace, Zdroj, Funkční požadavek, Nefunkční a technologický požadavek, Mimo a Neurčeno. Všechny zavádí kapitola Zadávací dokumentace a její zpracování.

Oblast je pojmenovaná podle svého hlavního výstupu, a proto obsahuje i to, co požadavkem není. Mimo drží formulace, které do rozsahu nepatří, Neurčeno drží otázky, které nelze rozhodnout. Obojí je součástí oblasti, protože se to eviduje.

Rozlišující znaky¶

Fáze, ne stupeň podrobnosti. Požadavky nejsou hodnotou osy Úrovně abstrakce. Nemají menší ani větší míru detailu implementace než HLA a LLA, jsou prostě dřív.
Roste i klesá. Oblast se doplňuje, jak přicházejí další podklady, a krátí se, když se ukáže, že položka neplatí. Není to jednorázově uzavřený seznam.
Podklad, ne popis systému. Požadavky říkají, co má systém splnit, ne jak je postaven. To drží HLA a LLA.
Obsahuje i nepožadavky. Mimo a Neurčeno jsou plnoprávnou součástí oblasti.

Nejčastější chyby¶

Záměna Analytické dokumentace s osou Úrovní abstrakce. Oblasti se seřadí jako stupně podrobnosti a hledá se, co je nad čím. Analytická dokumentace říká, co do práce patří; osa říká, jak podrobný je popis.
HLA a LLA jako dva úhly pohledu na tutéž věc. Z toho pak plyne otázka, který z nich je podrobnější. Nejsou to dva úhly. HLA popisuje okolí v kontextu použití systému, LLA chování a evidenci uvnitř, a jedno navazuje na druhé.
Vyloučení Zadávací dokumentace ven. Argumentuje se tím, že ji analytik nevytvořil. Rozhoduje ale evidence, ne autorství.
Vtažení celého projektu dovnitř. Do Analytické dokumentace se přiberou marketingové, obchodní a organizační věci, protože se v projektu vyskytly. Neprojdou testem výše.
Oblast prohlášená za hotovou zvlášť. Každá oblast se dokončí sama za sebe a soulad s ostatními se neověří. Úplnost jedné oblasti není hotová analytická dokumentace.
Požadavky jako uzavřený seznam. Po sepsání se oblast prohlásí za hotovou a další podklady se do ní nedoplňují. Vede to k tomu, že se pozdější informace nosí mimo evidenci.

Vazby¶

Analytická dokumentace je jedním ze dvou vymezení, na kterých stojí rozdělení analytické práce; druhým jsou Úrovně abstrakce, které říkají, jak podrobný je popis, kdežto tato kapitola říká, co do práce patří. Oblast LLA odpovídá hodnotě Analytický model IS na té ose. Oblast HLA popisuje kapitola Vrstvy HLA a LLA. Pojmy oblasti Požadavky zavádí Zadávací dokumentace a její zpracování. Rozlišení mezi řečí a evidencí, na kterém stojí hranice příslušnosti, popisuje Zrcadlení pojmů. Udržení souladu mezi oblastmi řeší Stroj konzistence AAF, Udržení konzistence UCM, Zákon zachování informace a Analysis Review. Hodnotu, kvůli které analytická práce vzniká, drží Axiom Value Based Management.

Verze a změny¶

Verze	Změny
1.2	Pojem Technologický požadavek přejmenován na Nefunkční a technologický požadavek podle kapitoly Zadávací dokumentace a její zpracování ve verzi 4.0.
1.1	Do výčtu pojmů oblasti Požadavky doplněn Zdroj, který zavedla kapitola Zadávací dokumentace a její zpracování ve verzi 3.1; počet pojmů je šest.
1.0	První verze kapitoly. Zaveden pojem Analytická dokumentace jako celek toho, co analytik odevzdává, a pojem Požadavky jako jedna ze tří oblastí; obojí dosud nemělo v metodice domov. Doplněno vymezení hranice příslušnosti podle evidence a nikoli podle autorství, odlišení analytické práce od zbytku projektu, a podmínka vzájemné odpovídavosti oblastí.