STM FEL, ČVUT Předávací protokol projektu Kos Klient Martin Tříska, Jiří Zamazal, Aleš Nejbr, Vladimír Klouček 16.12.2010 Tento protokol obsahuje popis všech předávaných součástí včetně jejich přesné lokace
Obsah 1 Dokumentace... 3 1.1 Uživatelské dokumentace... 3 1.1.1 Specifikační dokument... 3 1.1.2 Návod na instalaci... 3 1.1.3 Tutoriál... 3 1.2 Projektová dokumentace... 3 1.2.1 Akceptační test... 3 1.2.2 Analýza rizik... 3 1.2.3 Plán řízení jakosti... 3 1.2.4 Dokument infrastruktury... 3 1.2.5 Pracovní výkazy... 3 1.3 Technická dokumentace... 4 1.3.1 Požadavky... 4 1.3.2 Dokument vývojového prostředí... 4 1.3.3 Standard psaní zdrojových kódu... 4 1.3.4 Plán testování... 4 1.3.5 Diagram případu užití... 4 1.3.6 Diagram tříd... 4 1.3.7 Sekvenční diagramy... 5 1.3.8 Diagram nasazení... 5 1.3.9 Dokument návrhu... 5 1.4 Aplikace KosKlient... 5 1.5 Testy... 5
1 Dokumentace Veškerá dokumentace k projektu je umístěna v adresáři Dokumentace. Tyto dokumenty dále rozdělujeme podle cílového zaměření na dokumenty uživatelské, projektové a technické. Z důvodů kompatibility jsou tyto dokumenty převážně ve formátu PDF (pro jejich bezproblémové čtení je potřeba speciální aplikace například Adobe Acrobat), případně formáty XLS (tabulky, spustitelné pomocí nástrojů MS Office a podobných). 1.1 Uživatelské dokumentace 1.1.1 Specifikační dokument Popis: Soubor obsahuje specifikaci projektu a cílového produktu./dokumentace/specifikaceprojektu.pdf 1.1.2 Návod na instalaci Popis: Soubor obsahuje návod pro instalaci aplikace./dokumentace/instalace.pdf 1.1.3 Tutoriál Popis: Soubor obsahuje návod na používání aplikace KosKlient./Dokumentace/Tutoriál.pdf 1.2 Projektová dokumentace 1.2.1 Akceptační test Popis: Soubor obsahuje akceptační testy, které byly provedeny dodavatelem software./dokumentace/akceptačnítesty.xls 1.2.2 Analýza rizik Popis: Soubor obsahuje seznam rizik, jejich předpoklady, dopad a návrhy řešení./dokumentace/analýzarizik.pdf 1.2.3 Plán řízení jakosti Popis: Soubor obsahuje postupy vedoucí k zajištení kvality výsledné aplikace./dokumentace/plánřízeníjakosti.pdf 1.2.4 Dokument infrastruktury Popis: Soubor obsahuje informace o tom, jak byl organizován tým, vývoj a projektová práce./dokumentace/dokumentinfrastruktura.pdf 1.2.5 Pracovní výkazy Popis: Soubor obsahuje výkazy práce v hodinách jednotlivých členů týmu./dokumentace/výkazy.pdf
1.2.6 Zhodnocení projektu Popis: Soubor obsahuje závěrečné shrnutí a zhodnocení celého projektu./dokumentace/zhodnoceni.pdf 1.2.7 Prezentace Popis: Soubor obsahuje prezentaci k projektu Klient KOSu, rozdělenou na business a technickou část./dokumentace/prezentace.pptx 1.3 Technická dokumentace 1.3.1 Požadavky Popis: Soubor obsahuje seznam požadavků na výsledný produkt./dokumentace/požadavky.pdf 1.3.2 Dokument vývojového prostředí Popis: Soubor obsahuje informace o použitém vývojovém prostředí a návod, jak toto prostředí používat pro vývoj aplikace KosKlient. Tento dokument je přiložen ve dvou verzích. První verze (označena jako verze 1) je názorným průvodcem instalace a nastavení vývojového prostředí stylem krok za krokem a s využitím screenshotů obrazovky. Druhá verze dokumentu (verze 2) je určena pro zkušené technické pracovníky a návod poskytuje pouze textový../dokumentace/dokumentvývojovéprostředí.pdf (verze 1)./Dokumentace/TutoriálVývojovéProstředí.pdf (verze 2) 1.3.3 Standard psaní zdrojových kódu Popis: Soubor obsahuje informace o použitém standardu pro psaní zdrojových kódů, který je v aplikaci používán./dokumentace/standardpsanízdrojovýchkódů.pdf 1.3.4 Plán testování Popis: Soubor obsahuje plán testů./dokumentace/plántestování.pdf 1.3.5 Diagram případu užití Popis: Soubor obsahuje diagramy znázorňující případy užití aplikace./dokumentace/diagramusecase.pdf 1.3.6 Diagram tříd Popis: Soubor obsahuje návrh tříd v aplikaci../dokumentace/diagramclass.pdf
1.3.7 Sekvenční diagramy Popis: Soubor obsahuje sekvenční diagramy./dokumentace/diagramsekvencní.pdf 1.3.8 Diagram nasazení Popis: Soubor obsahuje diagram nasazení aplikace v cíleném prostředí a její vazby s okolím./dokumentace/diagramdeployment.pdf 1.3.9 Dokument návrhu Popis: Soubor obsahuje informace o navržené architektuře aplikace. Zároveň také spojuje diagramy tříd, nasazení, případů užití a sekvenční diagramy do jednoho celku./dokumentace/dokumentnávrh.pdf 1.4 Aplikace KosKlient Aplikace KosKlient je umístěna v adresáři KosKlient. Aplikaci tvoří přímo zdrojové kódy. Pro spuštění stačí spustit soubor kosklient.py. Více informací pro instalaci v dokumentu Návod na instalaci 1.5 Testy Obsažené testy by měli být použity a spouštěny pouze při dalším vývoji aplikace. Testy pro aplikaci KosKlient jsou umístěny v adresáři Testy a dalším adresáři tests. Tento adresář obsahuje jednotkové a regresní testy napsané pro aplikaci KosKlient. Spuštění testů se provádí spuštěním souboru run_tests.py. Ve složce Testy se vytvoří soubor results.html, který obsahuje informace o průběhu testů a jejich výsledku.