Jak pisać prace dyplomowe - o treści rozdziałów
Rozdział "teoretyczny"
Jeżeli praca ma charakter badawczy i/lub eksperymentalny,
to tu mogą być np. modele matematyczne, wzory itp.
Jeżeli praca ma charakter implementacyjny
(tzn. trzeba wykonać jakiś w miarę typowy produkt,
np. oprogramowanie wspierające prowadzenia działalności gospodarczej,
zarządzanie finansami, materiałami, usługami itp.)
to tu powinien się znaleźć opis stanu rzeczywistości, procedur biznesowych,
podobnych lub alternatywnych już istniejących rozwiązan itp.
Jeżeli opisujemy podobne, już istniejące rozwiązania (np. oprogramowanie
rozwiązujące ten sam lub podobny problem), to należy zwrócić uwagę i
opisać jakie funkcje się w tych rozwiązanich powtarzają,
aby z tego wywnioskować jakie usługi uznano za ważne i potrzebne.
Rozdział "projekt"
Aby wyjaśnić co ma się znaleźć w tym rozdziale posłużmy się analogią.
Kiedy buduje sie most, to nie przebiega to tak, że jednego dnia nad
rzekę przychodzą decydenci (politycy) i mówią "tu zbudujemy most",
a drugiego dnia przyjeżdżają koparki i każdy budowniczy coś sobie robi
w sprawie mostu. To byłby kompletny chaos.
Zamist tego, najpierw przyjeżdżają geodeci, potem projektanci projektują
most, potem przeprowadzana jest procedura administracyjna akceptująca projekt
(czy nie zniszczy środowiska, czy jest zgodny z normami, itp., itd.),
potem wg tego projektu budowany jest most, potem wjeżdzają ciężarówki z
ładunkiem i testowana jest nośność mostu.
Tworzenie oprogramowania nie odbiega od tego schematu.
Najpierw musi być stworzony projekt,
potem trzeba go zatwierdzić,
potem zaimplementować oprogramowanie,
potem je testować.
Państwa prace powinny być zgodne z tym schematem.
Dlatego należy zrobić projekt oprogramowania.
Projekt powinien zawierać takie elementy jak (stosownie do natury zadania):
- definicję pojęć,
- specyfikację wymagań,
- przypadki użycia,
- model powiązań między danymi (np. struktura bazy danych, diagram ERD),
- opis modułów w systemie,
- diagram przepływu informacji w aplikacji (jeżeli się przemieszczają),
- opis specyficznych struktur danych, procedur i funkcji, których
istnienie i sposób działania można przewidzieć już na etapie projektu,
- sposób testowania oprogramowania (in. opis planowanych testów).
Rozdział "opis implementacji"
W tym rozdziale trzeba opisać przebieg implementacji.
Tu mogą się znaleźć:
- opis użytych technologii i narzędzi 1)
- jeżeli coś trzeba instalować do użycia, to tu można krótko opisać instalację (o ile jest to coś nietypowego, nowego),
- istotne/odkrywcze wyjątki z kodu źródłowego programów,
- jeżeli zastosowano jakąś metodykę wytwarzania oprogramowania (np. scrum), to należy opisać przebieg procesu wytwarzania (np. co zrobiono w którym sprincie),
- wyniki przeprowadzonych testów jednostkowych/integracyjnych/funkcjonalnych/akceptacyjnych/efektywnościowych,
- opis ewentualnych trudności w implementacji, odkrytych artefaktów.
Ad 1)
Należy powiedzieć, czego użyto i w jakim celu.
Czasami jedno zdanie wystarcza (np. "PHP wykorzystano do stworzenia
warstwy logiki biznesowej", "MySQL wykorzystano jako bazę danych systemu".).
Proszę nie opisywać typowych narzędzi i technologii.
Np. nie opisywać HTML, PHP, MySQL (błagam! czytałem już to 1000 razy).
Tu najczęściej są popełniane plagiaty.
Rozdział "analiza wyników"
Ten rozdział występuje najczęściej w pracach o charakterze badawczym.
Należy tu zamieścić wyniki przeprowadzonych badań i omówić je
(tzn. wyjaśnić co z nich wynika).
Rozdział "podręcznik użytkownika"
Ten rozdział występuje najczęściej w pracach o charakterze implementacyjnym.
Należy tu zamieścić opis jak zainstalować system (jeżeli wymaga instalacji),
jak go używać (co można w nim "wyklikać").
Tu mogą być zrzuty ekranowe.
Jeżeli ten rozdział byłby zbyt obszerny (np. dłuższy niż rozdział
"projekt", lub "opis implementacji"), to można go przenieść do dodatków
na końcu pracy.
Maciej Drozdowski