Dokumentace software

Katedra elektrických pohonů a trakce

Dokumentace software Pro studenty YD14TED 2009-10 ČVUT - FEL


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,

• motor.feld.cvut.cz. 2/19

ČVUT - FEL

• ukázky SW projektů,


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.

• 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

ČVUT - FEL

• Vlastní SW práce (např. webové stránky, internetový obchod nebo třeba nějaká práce ze střední školy),


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),

• STSW – Specifikace testování softwaru (5). • Maximální celkový počet bodů: 30 4/19

ČVUT - FEL

• SNSW – Specifikace návrhu softwaru (4),


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. ČVUT - FEL

5/19


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,

• popis všech relevantních módů činnosti, • způsob samokotroly HW a SW. 7/19

ČVUT - FEL

• identifikace všech rozhraní s jinými systémy,


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,

• popis strategie vývoje SW.

9/19

ČVUT - FEL

• identifikace všech částí SW (nové, stávající, atd.),


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.,

11/19

ČVUT - FEL

• software musí mít hlavičku.


SNSW (4)

JavaDoc

Hlavička SW by měla obsahovat: • jméno software (modulu), • jméno autora, • verze, datum změny,

• historie změn (kdy, kdo, co, proč), • stručný popis co SW (metoda) dělá. 12/19

ČVUT - FEL

• stav (odladěno/neodladěno),


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é,

• prokázání, že každý modul plní správně svou funkci, • vytvoření zprávy o testování SW. 14/19

ČVUT - FEL

• projít všechny důležité cesty programu a kritická místa,


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é).

• Rozsah dokumentů celkem 8 až 12 stránek (1+2+3+5). 16/19

ČVUT - FEL

• Jména souborů Uzivatelske_jmeno_dokument.pdf (např. novakj7_SPSY.pdf).


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).

• Na dalších stránkách (na první již není třeba) vhodné záhlaví a v zápatí číslo stránky. 16/19

ČVUT - FEL

• Titulní stránka: název projektu, o kterou část dokumentace jde, předmět a školní rok, informace o autorovi, datum


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.

16/19

ČVUT - FEL

• Abstrakt, klíčová slova a literatura se nevyžadují.


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).

*.zip

17/19

ČVUT - FEL

• Jméno zip souboru Uzivatelske_jmeno_SNSW.zip (např. novakj7_SNSW.zip).


Odevzdání – hodnocení: • Odevzdání do 30.5.2010. • 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í.

18/19

ČVUT - FEL

• Za pozdní odevzdání ztráta 25 % bodů (tedy 7,5 ze 30).


Shrnutí: SPSY SPSW SASW

*.pdf

8-12 str. celkem

STSW Java + JavaDoc

*.zip

Odevzdání do 30.5.2010

19/19

ČVUT - FEL

SNSW

Dokumentace software

Recommend Documents