Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

Dokumentace software

Pro studenty YD14TED

2009-10

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

2/19

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.

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

3/19

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.

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

4/19

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

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

5/19

SPSY (1)

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.

*.pdf

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

7/19

SPSW (2)

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.

*.pdf

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

9/19

SASW (3)

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.

*.pdf

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

11/19

SNSW (4)

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.

JavaDoc

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

12/19

SNSW (4)

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

JavaDoc

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

14/19

STSW (5)

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.

*.pdf

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

16/19

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 (1+2+3+5).

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

16/19

Odevzdání - forma

Dokumenty SPSY(1), SPSW(2), SASW(3), STSW(5):

• Každý dokument bude obsahovat titulní stránkua alespoň dvě další stránky(v případě SPSY někdy stačí jen jedna).

• Titulní stránka: název projektu, o kterou částdokumentace 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.

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

16/19

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žujtepodobně jako u odborného článku.

• Dbejte na jazykovou stránku práce.

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

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

17/19

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

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

18/19

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

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

Katedra elektrických pohon ů a trakce

ČV

UT

-F

EL

19/19

Shrnutí:SPSY

SPSW

SASW

STSW

*.pdf

SNSWJava +

JavaDoc*.zip

Odevzdání do 30.5.2010

8-12 str. celkem