background image

Autor: ................................................grupa:.......

Warszawa, ....

Prowadzący:
termin zajęć: ...........

Zasady programowania strukturalnego - projektowanie

Dokumentacja końcowa projektu

UWAGA:    Dokumentacja  prototypu  kończy  się  na  cz.  V.  Dokumentacja  prototypu  i  dokumentacja
ko
ńcowa  może  nie  zawierać  tych  punktów, 

które  były  w  dokumentacji  wcześniejszej  i  nie  uległy

zmianie w trakcie opracowania projektu.

cz. I - ogólna
1.

  Temat (w postaci podanej przez prowadzącego)

2.

  Założenia dodatkowe (nie określone w temacie, a przyjęte przez autora) - o ile są.

cz. II - wejście/wyjście
3.

  Format danych wejściowych

4.

  Format danych wyjściowych.

cz. III - struktury danych
5.

  Wykaz  struktur  danych  zastosowanych  w  aplikacji  i  informacje,  jakie  dane  są  w  nich

przechowywane, spośród poniższych:

•  tablice statyczne
•  tablice dynamiczne
•  dynamiczne struktury listowe, proste i zaawansowane
•  drzewa binarne (BST, AVL, RBT) lub inne

6.

  Rysunki  uzupełniające  (mogą  być  odręczne)  -  np.  w  przypadku  zaawansowanych  struktur

listowych.

cz. IV - algorytmy
7.

  Wykaz algorytmów, które zostały zastosowane

8.

  Zwięzły,  poglądowy  opis  ważniejszych  algorytmów  (wraz  z  ewentualnym  odwołaniem  do

literatury,  również  Internetu;  do  prezentacji  z  wykładu  oraz    do  lekcji  w  podręczniku
internetowym AiSD wystarczy się odwołać - nie przepisywać opisu)

9.

  Sieć  działań  wybranych  algorytmów  (może  być  odręcznie  narysowana)  -  jeśli  upraszcza  lub

zastępuje  opis

10.

 Oszacowanie kosztu (złożoności czasowej i/lub pamięciowej) algorytmów – wskazane.

cz. V - implementacja
11.

 Podział aplikacji na moduły - wykaz modułów, ich funkcja, powiązania między modułami

12.

 Wykaz i opis podprogramów (funkcji, procedur) realizowanych przez każdy z modułów:

•  nagłówek  podprogramu
•  co on robi
•  jakie ma parametry formalne i jaką rolę one pełnią

13.

 Wykaz i opis zmiennych globalnych (jeśli są i pełnią ważną rolę).

cz. VI - uruchomienie i testowanie
14.

 Zakres wykonanych prac (co tak naprawdę program robi)

15.

 Opis funkcjonalności aplikacji (instrukcja użytkownika)

16.

 Opis przeprowadzonych testów (zestawów danych testowych, wyników działania).

Załączniki:
1.

  Wykaz plików z kodem źródłowym projektu (i komentarzami w kodzie)

2.

  Wykaz plików z danymi testowymi

3.

  Wykaz plików z wynikami działania.

UWAGA:  Wszystkie  pliki  wraz  z dokumentacją  muszą  być  dostarczone  prowadzącemu  przed
zaliczaniem  projektu.  Dokumentacja  musi  by
ć  ponadto  wydrukowana,  uzupełniona  rysunkami
i przyniesiona na zaliczanie.