Dokumentacja techniczna

Struktura tego rozdziału mocno zależy od architektury danego rozwiązania, zastosowanych metod i narzędzi realizacji. Należy rozpocząć od schematu rzeczywistej struktury systemu, prezentującego poszczególne składowe: pakiety, moduły, biblioteki, klasy. Każda składowa powinna zostać omówiona, opis powinien zawierać nazwę składowej, jej rolę w projekcie, przeznaczenie, strukturę wewnętrzną.

Ten rozdział to dobre miejsce na umieszczenie różnorodnych diagramów projektowych, takich jak diagram hierarchii klas, diagramy sekwencji, kolaboracji, itp., itd.. Tutaj można przedstawić opisy metod i/lub stosowane algorytmy.

Przy opisie składowych systemu warto przedstawić fragmenty wybranych kodów źródłowych, prezentujące szczególnie istotne, ciekawe czy nietypowe rozwiązania oraz algorytmy. Nie należy przedstawiać fragmentów kodu operacji typowych lub trywialnych. Proszę nie zamieszczać długich, ciągnących się przez wiele stron listingów kodu. Opis kodu zapisujemy w sekwencji: kilka linijek a potem fragment opisujący istotne operacje realizowane w kodzie, kilka linijek a potem fragment opisujący istotne operacje realizowane w kodzie… itd.

Fragmenty kodu proszę zamieszczać jako odpowiednio sformatowane teksty, zwykle pisane nieproporcjonalnym krojem pisma. Proszę zadbać o to, by zamieszczane kody były poprawne z punktu widzenia inżynierii programowania, poprawne merytorycznie oraz właściwie sformatowane. Proszę nie umieszczać w tekście fragmentów kodu w postaci rysunków zawierających zrzuty ekranów.

Proszę pamiętać, że praca inżynierska ma być wymiernym dowodem wysokich kompetencji jej autora w zakresie informatyki, niechlujny kod takich kompetencji nie potwierdza.