Specifikace a dokumentace projektu díl 3.

Referenční a uživatelské příručky budou náplní našeho dnešního dílu minisérie o dokumentování projektů.

Na konec to nejlepší

Abychom se mohli tentokrát bavit o výsledném dokumentování projektu, rozdělíme si toto opět na podcelky, které dohromady tvoří způsob popisu systému:
  • Referenční příručka systému
  • Uživatelská příručka systému

Referenční příručka systému

Referenční příručka obsahuje úplný popis funkcí systému a její naplnění se kontroluje dle globální analýzy systému a analýzy uživatelského ovládání. Struktura uživatelské příručky se tedy rovná struktura uživatelského ovládání systému. Každá referenční příručka obsahuje tyto části:
  • Referenční příručka informačního systému.
  • Referenční příručka subsystému.
  • Referenční příručka funkce.

Referenční příručka informačního systému

Vzhledem k celkovému pojetí tohoto dokumentu, jeho výstavba a pravidla k ní totiž nelze popsat komplexně v rámci této série, nám postačí vědět, že se do něj pokoušíme zanést koncepci cílové architektury v rámci základních IT standardů. Zaměříme se proto spíše na další příručku:

Referenční příručka subsystému

V tomto textovém dokumentu popisujeme účel a začlenění systému z pohledu podpory činností organizace. Je v něm nutné zohlednit požadované technické a softwarové vybavení a podmínky provozu systému. Dále také obsahuje instalační instrukce pro produkt, diferencování uživatelů dle privilegií či samotný popis struktury subsystému.

Další důležitou částí je popsání vstupů a výstupů funkcí v rámci subsystému členěném na funkce. Nesmíme zapomenout ani na ovládání obecných úloh systému jako je přihlašování do něj spolu s tím jak systém vlastně uživatel ovládá. Jedna ze základních pouček říká: „Referenční příručka nesmí vznikat až po naprogramování.“ V jejím duchu mne napadá paralela s napsáním nového receptu týden po tom, co jsme jednou uvařené jídlo snědli – nejde samozřejmě jen o další pohled na systém jako celek, dokument je určen především uživatelům a správci systému, kontroluje se však podle něj opět kvalita výsledného produktu.

Referenční příručka funkce

Řekněme si hned úvodem, že popisy funkcí systému slouží jeho uživatelům k jeho pochopení což platí i pro nás za určitých podmínek:). V rámci textového zpracování takovéhoto popisu uvádíme především účel a uživatelské ovládání funkce, pokyny k obsluze (ovládací a funkční klávesy, popisy obrazovek a jejich posloupnost a ošetření informačních a chybových zpráv) a jak se zachovat, dojde-li k pomyslnému výpadku jejího zpracování.

Příručka uživatele systému

V rámci této příručky popisujeme funkce systému z pohledu plnění uživatelských postupů. Závěry pak tvoří procesní analýzy a všechny se řídí potřebami uživatelů. Proto popisujeme, jak pomocí série čiností jednotlivé potřeby uživatelů naplnit. Základní členění příručky uživatele systému tedy je:
  • Příručka uživatele systému.
  • Příručka správce systému.

Příručka uživatele systému

V této dokumentaci navazujeme na referenční příručku zásadami uživatelského ovládání. Uživatelské postupy, které popisujeme, vyplývají z procesní analýzy. Máme možnost členění příručky na kapitoly podsystémů. Pro činnosti pak zaznamenáváme jejich popis s možným doplněním obrázkem, posloupnosti obrazovek pro jejich vykonání, jak řešit problémové situace v rámci jednotlivých obrazovkách.

Při tvorbě takovéhoto dokumentu bychom měli vycházet z neautomatizovaných uživatelských procedur, protože je určen právě obyčejným uživatelům.

Příručka správce systému

Zásady pro administrování systému patří právě sem – při stavbě vycházíme ze stejných pravidel jako u příručky uživatele systému. Není relevantní brát v potaz nadměrnou technickou zdatnost potencionálních administrátorů systému, pro nás je v zásadě administrátor na stejné úrovni jako běžný uživatel s tím, že může natropit i škody v systému!:) Nyní si uvedeme ještě několik užitečných rad:

Korekce stanovených priorit systému

Takovéto korekce vycházejí vždy ze zkušenostní ze zkušebního provozu a přehodnocení business situace. Podklady zde připravuje vedoucí projektu spolu s garantem problému.

Odsouhlasení rutinní provoz systému

Změny se v případě, že TSI nerozhodne o vytváření nové verze prototypu, realizují až v rámci projektu „Údržba“. V opačném případě se používá přírůstek rutinně, ale jeho kopie slouží jako výchozí bod pro novou verzi prototypu.

Pojem prototyp

Nyní by asi nebylo od věci si ujasnit, co vlastně rozumíme pod možnostmi prototypu. Prototyp z pravidla dokáže:
  • Naplnit databázi přírůstku skutečnými daty.
  • Běžný provoz přírůstku nad skutečnými daty.
  • Komunikace mezi IKU (informačně komunikační uzly) v rámci přírůstku.
  • Archivování dat a následnou rekonstrukci databáze z nich.
  • Časově neomezenou možnost vykonávat ostrý provoz.
Prototyp většinou nedokáže:
  • Není imunní proti chybám obsluhy.
  • Nezajišťuje plně transakční zpracování.
  • Nepracuje v architektuře Client – Server.
  • Lze přivodit nekorektní manipulací ztráty dat.
  • Systém není optimalizován.
Z tohoto tedy vyplývá, že prototyp zdaleka není robustním řešení, ale při správné konstrukci lze plně využívat neomezeně dlouhou dobu.

Doporučená struktura adresářů projektu s popisem:

Klepněte pro větší obrázek

Etapa

Při jednoetapovém projektu se tento adresář vynechává, etapa se dělí na kroky čemuž odpovídají adresáře kroků.

Krok

Uchovávají se zde všechny vývojové verze produktům které jsou spojeny s tímto příslušným krokem případně musí zde být uložen popis, kam byly uloženy. Jména souborů zde nepodléhají žádné konvenci.

WS a Porady

Adresář obsahuje scénáře, programy a zápisy všech pracovních porad spolu s jejich podpůrnými soubory – excelovskými tabulkami, databázemi apod.. U rozsáhlých projektů se adresář vnořuje do adresářů Etapa 1 – Etapa n. Lze zde mít i podadresáře pro jednotlivé semináře.

Organ

Zde se uchovávají dokumenty s návazností na řízení a plánování projektu, což jsou i rozpisy prací, zápisy celoprojektových schůzek či výkazy aktivit jednotlivých pracovníků. Opět je možné vnořit adesář do Etap 1 – n.

Metodika

Tento adresář plní dokumenty metodické povahy, jako je metodika vytváření datových modelů.

Výsledky

Zde jsou výsledné verze souborů coby výsledky postupových kroků projektu. Opět zde máme možnost vnoření do Etap 1 - n.

Kontrola kvality systému

Kontrolou kvality systému myslíme porovnání naprogramovaného subsystému se specifikací v projektových plánech, technickou a výslednou dokumentací. Takovéto porovnání předvádí dodavatel garantovi problému a TSI. Výsledné odsouhlasené hodnocení kvality systému je možné poté předložit RVP.

Časový harmonogram kroků

Jednou z užitečných věcí je vytvořit si závazný časový harmonogram pro náš projekt:

Klepněte pro větší obrázek

Praxe!:)

Abychom se konečně dostali k praxi, začneme dnes již tvořit naši první jednoduchou specifikaci projektu. První krok bude si ji rozčlenit:

Obsah:

  • Předmět projektu.
  • Postup prací na projektu.
  • Personální obsazení projektu.
  • Časový harmonogram kroků.

K jednotlivým položkám poté doplníme příslušné stránkování v rámci specifkace pro lepší orientaci.

Předmět projektu

1.1 Cíle

Cílem projektu je vytvoření programu, který bude poskytovat informace o hardwarových vlastnostech a operačním systému počítače, na kterém je spuštěn. Tento program bude sestávat z klientské a serverové aplikace, které spolu budou navzájem komunikovat přes www rozhraní.

Klientská aplikace určená pro všechny běžně dostupné operační systémy, dostupná ke stažení na internetu, bude zjišťovat informace o hardwarové konfiguraci uživatele (dostupné a relevantní údaje doplněné IP adresou testovaného počítače) spolu s jeho operačním systémem. Po spuštění zašle klientská aplikace přes internet (http protokolem) data v binární podobě na server.

Na serveru budou data serverovou aplikací zpracována, interpretována podle tabulek a následně uložena do databáze výsledků. Zároveň budou zpracovaná data zaslána zpět klientské aplikaci, která je zobrazí formou webové stránky testovanému subjektu.

Tato stránka bude v přehledné formě souhrnně popisovat získané informace o operačním systému a konfiguraci testovaného počítače a bude umožňovat upozornit další uživatele, jejichž email se zadá do příslušných kolonek na stránce, na možnost otestovat svůj počítač. Každý test bude zároveň umožňovat odkrytí anonymity uživatele a jeho zařazení do veřejného žebříčku počítačů podle výkonnosti. Ta se bude hodnotit podle danných kritérií.

1.2 Výstup

  • Klientská aplikace ve Visual Basicu se zdrojovými texty.
  • Serverová aplikace v PHP využívající databází MySQL k vlastnímu zpracování.
  • Webové stránky zobrazující zpracovaná data a přehled nejlepších počítačů s povoleným zařazením do tohoto žebříčku.

1.2 Akceptační kritéria

  • Vytvořené stránky budou sestávat ze získaných informací v textové podobě doplněné obrázkem uživatelova CPU (pokud je obrázek dostupný).
  • Všechny odkazy webového rozhraní budou funkční.

  • Bude funkční webový žebříček neanonymních počítačů a statistické zpracování všech testovaných položek.

  • Aktualizovatelná databáze hardwarových dat bude uložena na serveru.

  • Klientská aplikace bude zadavateli předána na výměnném médiu tak, aby ji bylo možné snadno nainstalovat na uživatelský počítač.

  • Klientská aplikace bude k dispozici také ke stažení přes internetu.

Příště si dokončíme ukázku praktické specifikace projektu.

Váš názor Další článek: Šifra RC5-64 byla rozluštěna

Témata článku: Software, Programování, Rámec, Díl, Personální obsazení, Specifikace, Etapa, Projekt, Jednoduchá rekonstrukce, Zdatnost, Kontrola kvality, Zdrojový text, Dostupné funkce, Základní popis, SPEC, Uživatelské ovládání, Hardwarová údržba, Krok, Technická specifikace, Základní věc, Uživatelská data, Systém, Dok, Dokumentace, Základní struktura


Určitě si přečtěte

Pozor, na Česko v těchto dnech útočí falešné Tesco, Penny Market a Lidl

Pozor, na Česko v těchto dnech útočí falešné Tesco, Penny Market a Lidl

** Máme tu další českou phishingovou vlnu ** Podle průzkumů máme stále problém s kybernetickou gramotností ** Nebezpečím jsou děti, které opouštějí rodiče

Jakub Čížek | 34

Co všechno se spouští se startem Windows a proč by vás to mělo zajímat

Co všechno se spouští se startem Windows a proč by vás to mělo zajímat

** Společně s operačním systémem se spouští řada aplikací a služeb ** Mohou mít negativní dopad na celkovou dobu startu Windows ** Jak získat kontrolu nad automaticky spouštěnými programy?

Karel Kilián | 57

Nejlepší notebooky do 10 000 korun: Co koupit a čemu se raději vyhnout

Nejlepší notebooky do 10 000 korun: Co koupit a čemu se raději vyhnout

** Do deseti tisíc korun lze dnes koupit slušné notebooky ** V nabídce ale i tak převládají zastaralé a pomalé modely ** Poradíme, jak dobře vybrat i s omezeným rozpočtem

David Polesný | 109


Aktuální číslo časopisu Computer

Megatest: 20 powerbank s USB-C

Test: mobily do 3 500 Kč

Radíme s výběrem routeru

Tipy na nejlepší vánoční dárky