Předávací protokol projektu Kos Klient

Rozměr: px

Začít zobrazení ze stránky:

Download "Předávací protokol projektu Kos Klient"

Rudolf Bezucha
před 7 lety
Počet zobrazení:

1 STM FEL, ČVUT Předávací protokol projektu Kos Klient Martin Tříska, Jiří Zamazal, Aleš Nejbr, Vladimír Klouček Tento protokol obsahuje popis všech předávaných součástí včetně jejich přesné lokace

2 Obsah 1 Dokumentace Uživatelské dokumentace Specifikační dokument Návod na instalaci Tutoriál Projektová dokumentace Akceptační test Analýza rizik Plán řízení jakosti Dokument infrastruktury Pracovní výkazy Technická dokumentace Požadavky Dokument vývojového prostředí Standard psaní zdrojových kódu Plán testování Diagram případu užití Diagram tříd Sekvenční diagramy Diagram nasazení Dokument návrhu Aplikace KosKlient Testy... 5

3 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 Specifikační dokument Popis: Soubor obsahuje specifikaci projektu a cílového produktu./dokumentace/specifikaceprojektu.pdf Návod na instalaci Popis: Soubor obsahuje návod pro instalaci aplikace./dokumentace/instalace.pdf Tutoriál Popis: Soubor obsahuje návod na používání aplikace KosKlient./Dokumentace/Tutoriál.pdf 1.2 Projektová dokumentace Akceptační test Popis: Soubor obsahuje akceptační testy, které byly provedeny dodavatelem software./dokumentace/akceptačnítesty.xls Analýza rizik Popis: Soubor obsahuje seznam rizik, jejich předpoklady, dopad a návrhy řešení./dokumentace/analýzarizik.pdf Plán řízení jakosti Popis: Soubor obsahuje postupy vedoucí k zajištení kvality výsledné aplikace./dokumentace/plánřízeníjakosti.pdf Dokument infrastruktury Popis: Soubor obsahuje informace o tom, jak byl organizován tým, vývoj a projektová práce./dokumentace/dokumentinfrastruktura.pdf Pracovní výkazy Popis: Soubor obsahuje výkazy práce v hodinách jednotlivých členů týmu./dokumentace/výkazy.pdf

4 1.2.6 Zhodnocení projektu Popis: Soubor obsahuje závěrečné shrnutí a zhodnocení celého projektu./dokumentace/zhodnoceni.pdf Prezentace Popis: Soubor obsahuje prezentaci k projektu Klient KOSu, rozdělenou na business a technickou část./dokumentace/prezentace.pptx 1.3 Technická dokumentace Požadavky Popis: Soubor obsahuje seznam požadavků na výsledný produkt./dokumentace/požadavky.pdf 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) 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 Plán testování Popis: Soubor obsahuje plán testů./dokumentace/plántestování.pdf Diagram případu užití Popis: Soubor obsahuje diagramy znázorňující případy užití aplikace./dokumentace/diagramusecase.pdf Diagram tříd Popis: Soubor obsahuje návrh tříd v aplikaci../dokumentace/diagramclass.pdf

5 1.3.7 Sekvenční diagramy Popis: Soubor obsahuje sekvenční diagramy./dokumentace/diagramsekvencní.pdf Diagram nasazení Popis: Soubor obsahuje diagram nasazení aplikace v cíleném prostředí a její vazby s okolím./dokumentace/diagramdeployment.pdf 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.

Podobné dokumenty

Dokument rozchození vývojového prostředí

STM FEL, ČVUT Dokument rozchození vývojového prostředí Martin Tříska, Aleš Nejbr, Jiří Zamazal, Vladimír Klouček 29. 1. 2010 Verze 1.0 Obsah Seznam obrázků 4 1 Předpoklady a závislosti 6 2 Nástroj pro