Dokumentace software

Rozměr: px

Začít zobrazení ze stránky:

Download "Dokumentace software"

Bohumír Ševčík
před 7 lety
Počet zobrazení:

1 Dokumentace software Pro studenty YD14TED

2 Přednášky Přednášky na téma dokumentace SW (9. až 13. t.), 1. etapy (projektování SW), druhy dokumentů, 2. malý SW projekt (ukázka), 3. prostředky pro popis etap vývoje software, verzovací programy, ukázky SW projektů, motor.feld.cvut.cz. 2/19

3 Volba tématu Téma je možno si vybrat z: Programování ALG (zimní semestr). Programování v jazyku Java PJV (letní semestr), event. též WMM nebo SAP. Vlastní SW práce (např. webové stránky, internetový obchod nebo třeba nějaká práce ze střední školy), Nevolit však nepřiměřeně jednoduché téma (např. řešení kvadratické rovnice) téma má být dostatečné pro požadovaný rozsah. 3/19

4 Odevzdávané dokumenty Bude se odevzdávat pět následujících dokumentů: SPSY Specifikace požadavků na systém (1), SPSW Specifikace požadavků na software (2), SASW Specifikace architektury softwaru (3), SNSW Specifikace návrhu softwaru (4), STSW Specifikace testování softwaru (5). Maximální celkový počet bodů: 30 4/19

5 SPSY (1) *.pdf SPSY Specifikace požadavků na systém: zadání co to má dělat co si zákazník přeje, jaké jsou vstupní podmínky a požadavky, požadavky na funkcionalitu vytvářeného softwaru. 5/19

6 SPSW (2) *.pdf SPSW Specifikace požadavků na software: tzv. detailní analýza, definuje úplný soubor požadavků na SW (i na HW), požadované vlastnosti vytvářeného softwaru, identifikace všech rozhraní s jinými systémy, popis všech relevantních módů činnosti, způsob samokotroly HW a SW. 7/19

7 SASW (3) *.pdf SASW Specifikace architektury software: jak to bude programově realizováno, popisuje význam všech interakcí mezi HW a SW, dokumentace použití staršího kódu, identifikace všech částí SW (nové, stávající, atd.), popis strategie vývoje SW. 9/19

8 SNSW (4) JavaDoc SNSW Specifikace návrhu software: jak je to konkrétně navrženo a realizováno, zdrojový kód s komentáři např. Java+JavaDoc, může být i v jazyku C, HTML, PHP, Pascal apod., software musí mít hlavičku. 11/19

9 SNSW (4) JavaDoc Hlavička SW by měla obsahovat: jméno software (modulu), jméno autora, verze, datum změny, stav (odladěno/neodladěno), historie změn (kdy, kdo, co, proč), stručný popis co SW (metoda) dělá. 12/19

10 STSW (5) *.pdf STSW Specifikace testování software: jak se bude testovat, každý SW musí mít specifikaci pro testování, testy musí být opakovatelné, projít všechny důležité cesty programu a kritická místa, prokázání, že každý modul plní správně svou funkci, vytvoření zprávy o testování SW. 14/19

11 Odevzdání - forma Dokumenty SPSY(1), SPSW(2), SASW(3), STSW(5): Textové dokumenty odevzdávané ve formátu PDF. Doplněno o grafické prvky (blok. schémata, diagramy, tabulky, snapshoty vše řádně titulkované). Jména souborů Uzivatelske_jmeno_dokument.pdf (např. novakj7_spsy.pdf). Rozsah dokumentů celkem 8 až 12 stránek ( ). 16/19

12 Odevzdání - forma Dokumenty SPSY(1), SPSW(2), SASW(3), STSW(5): Každý dokument bude obsahovat titulní stránku a alespoň dvě další stránky (v případě SPSY někdy stačí jen jedna). Titulní stránka: název projektu, o kterou část dokumentace jde, předmět a školní rok, informace o autorovi, datum Na dalších stránkách (na první již není třeba) vhodné záhlaví a v zápatíčíslo stránky. 16/19

13 Odevzdání - forma Dokumenty SPSY(1), SPSW(2), SASW(3), STSW(5): Veškeré obrázky mohou být barevné. Formální a typografická pravidla jinak dodržujte podobně jako u odborného článku. Dbejte na jazykovou stránku práce. Abstrakt, klíčová slova a literatura se nevyžadují. 16/19

14 Odevzdání - forma Dokument SNSW(4): Zdrojový kód s komentářem. Ideální Java+JavaDoc. Nebo jiné programovací prostředky (dle typu práce). Jméno zip souboru Uzivatelske_jmeno_SNSW.zip (např. novakj7_snsw.zip). *.zip 17/19

15 Odevzdání hodnocení: Odevzdání do Zaslat mailem Ing. Zděnkovi jako přílohu. Oprava off-line. Seznámení s výsledky při závěrečném soustředění. Za pozdní odevzdání ztráta 25 % bodů (tedy 7,5 ze 30). 18/19

16 SPSY Shrnutí: SPSW SASW STSW *.pdf 8-12 str. celkem SNSW Java + JavaDoc *.zip Odevzdání do /19

Podobné dokumenty

Elektronická technická dokumentace Bc. Lukáš Procházka

17, 18. hodina Elektronická technická dokumentace Bc. Lukáš Procházka Téma: závěrečná část dokumentu, dodatky a manuály 1) Závěrečná část dokumentu 2) Dodatky 3) Manuály a návody obsah dokumentu Závěrečná