Dokumentacja powinna składać się z następujących części:
opracowanie
• strona tytułowa wyszczególniająca :
o nazwę projektu
o autora
o numer indeksu
• spis treści
• treść projektu
• podstawowe
założenia jakie przyjął programujący przystępując do pracy
o
diagramy klas wraz z wzajemnymi relacjami
o zakładany
algorytm działania programu wraz z wyszczególnieniem punktów krytycznych
• modyfikacje w pierwotnych założeniach
o opis zmian
(uzasadnienie)
• końcowy wygląd aplikacji
o
diagramy klas wraz z wzajemnymi relacjami
o zakładany
algorytm działania programu wraz z wyszczególnieniem punktów krytycznych
• opis elementów dodatkowych umieszczonych w programie wraz z ilustracją
• listing programu zgodny z stylem jbl opisanym w licznych publikacjach
prof. Jana Bieckiego
! wykorzystując możliwości szybkiej
edycji tekstu wprowadzamy następujące ograniczenia:
o
nagłówki nie mogą być większe niż 18 punktów
o tekst należy
pisać czcionką „Times New Roman” o rozmiarze 12 punktów
o
pojedyncza interlinia
o kod programu należy pisać czcionką „Courier
New” o rozmiarze 10 punktów
nośnik magnetyczny (dyskietka 3½)
lub optyczny (płyta CD)
• katalog główny – numer studenta
np.(s0534)
o podkatalog src – zawierający źródła programu
o podkatalog bin – zawierający wszystkie potrzebne do uruchomienia składniki
o podkatalog doc – zawierający elektroniczną wersję dokumentacji
Dokumentację tj. wydruk części opisowej wraz z nośnikiem należy zapakować w
„koszulkę” biurową formatu A4, a następnie zostawić w dniu i miejscu
wskazanym przez prowadzącego.
Uwaga:
Z
dotychczasowych prac studenckich nasuwają się następujące wnioski:
- częstym błędem popełnianym przez studentów jest tworzenie kodu aplikacji,
bez uprzedniego przemyślenia konstrukcji używanych w programie.
- dokumentacja jest tworzona po zakończeniu procesu twórczego, a etapy
pośrednie są „dogenerowywane”
