Jak napisać pracę dyplomową - poradnik dla

Jak napisać pracę dyplomową - poradnik dla studenta
Marek Zachara ([email protected])
1
Tytułem wstępu
Niniejszy poradnik powstał na bazie moich doświadczeń w prowadzeniu prac dyplomowych inżynierskich i magisterskich. Zawiera zbiór porad oraz sugestii dotyczących zarówno zawartości
pracy dyplomowej jak i sposobu pracy. Nie są to w żadnym wypadku oficjalne wytyczne Uczelni
czy Wydziału. Poradnik jest przeznaczony przede wszystkim dla moich dyplomantów, jednak
każdy student może z niego korzystać - przede wszystkim należy jednak skontaktować się ze
swoim promotorem i poznać jego wymagania!
2
Plan i realizacja prac
Po pierwsze - od czego zacząć? Zakładając że tytuł pracy jest już znany, sugeruję aby ustalić
sobie cele pracy. Zarówno cel końcowy (co planujecie osiągnąć) jak i cele pośrednie (np.
zapoznanie się z technologią czy metodą, przygotowanie konkretnego algorytmu itp.).
Następnym krokiem powinno być zapoznanie się z aktualnym stanem wiedzy w zakresie
analizowanej dyscypliny/tematu (tzw. State of the Art). W tym celu należy spędzić trochę
czasu czytając (lub choć przeglądając) książki i artykuły z danej dziedziny.
Jeżeli praca obejmuje przygotowanie aplikacji, urządzenia lub systemu proponuję zabrać się
za to, w oparciu o pozyskaną wiedzę. Jednym z często powtarzających się błędów jest rozpoczęcie implementacji przed realizacją opisanego wyżej kroku, co często skutkuje ’wyważaniem
otwartych drzwi’ i zmarnowaną pracą.
Jeśli już udało się mniej więcej dopracować istotne merytoryczne kwestie (np. wykonać
aplikację która realizuje zakładany algorytm), i widać już kształt jaki będzie przybierać praca,
to proponuje przygotować planowany spis treści. Oczywiście może on się jeszcze w przyszłości
zmieniać, ale pomoże ustrukturyzować koncepcję i uprości dalsze prace. Spis ten powinien składać się z głównych rozdziałów, podrozdziałów i krótkich opisów zawartości. Przykład takiego
spisu znajduje się poniżej.
1. Wstęp
- opis powodów rozpoczecia prac nad tym tematem, opis stosowanych metod
1.1 Cel pracy
- opis klasy atakow które można zidentyfikowac za pomoca opracowanego systemu
1.2 Struktura pracy
- skrótowy opis zawartości rozdziałów
2. Aktualne problemy bezpieczeństwa systemów
- opis znanych zagrożeń i konsekwencji wynikajacych z użytkowania systemow komputerowych w
sieci.
2.1 Rodzaje zagrożeń
- Podział zagrożeń na klasy (zewnętrzne, wewnętrzne, techniczne, osobowe) i podklasy (szczegółowe w zależnosci od konsekwencji i rodzaju działań)
2.2 Poziomu bezpieczeństwa
...
1
Po uzgodnieniu planu pracy można równolegle (lub na zmianę) prowadzić np. rozwój tworzonej aplikacji/systemu i przygotowywać kolejne rozdziały. Pozwoli to zmniejszyć znużenie
związane z długotrwałą pracą nad jednym zadaniem. Sugeruję, żeby szczególnie pierwsze rozdziały podesłać do oceny od razu (nie w większej partii), ponieważ ew. uwagi zwrotne co
do stylu, sposobu zapisu czy edycji pozwolą uniknąć błędów w kolejnych. Na koniec należy
dostarczyć całą prace w ostatecznej formie do końcowego przeglądu i oceny.
2.1
Konsultacje w trakcie postępów prac
Zapraszam do konsultowania pracy tak często jak to jest Wam potrzebne. Wiedząc jednak z
doświadczenia że niektórzy studenci starają się ograniczyć swój kontakt z promotorem, jako
minimum uznaję:
• Uzgodnienie celów i metod realizacji pracy
• Prezentację i uzgodnienie spisu treści z opisem rozdziałów
• Przedstawienie pierwszego większego rozdziału do oceny
• Przedstawienie całej pracy
2.2
Wspólna praca nad tekstem
Generalnie, dokumenty (rozdziały, pracę) do korekty proszę mi przysyłać w formacie Open
Document Format (pliki .odt). Wielu studentów wykorzystuje LATEXdo przygotowania pracy
dyplomowej. Jest to bardzo dobre narzędzie, jednak w tym konkretnym wypadku ma istotną
wadę - niespecjalnie nadaje się do wspólnej pracy nad tekstem i jego korekty (brak możliwości
oznaczania zmian, komentarzy itp.).
Dlatego w przypadku przygotowywania dokumentów w tym środowisku do oceny należy
mi przysyłać zawsze dwie wersje dokumentu (rozdziału czy pracy). Wygenerowany PDF oraz
dokument ODT uzyskany po konwersji PDF-a lub TEX-a. Można to zrobić na kilka sposobów,
w zależności od posiadanych aplikacji - poniżej kilka przykładowych:
• Konwersja PDF->ODT: Word 2013, Adobe Acrobat, ABBYY PDF Converter, jest też
sporo darmowych konwerterów on-line.
• Konwersja TEX->ODT: latex2html lub tex2ht -> html -> libreoffice, pandoc itp.
2.3
Typowe błędy
Do typowych błędów dyplomantów należą
• Brak ’rozpoznania terenu’ - czyli zapoznania się z literaturą. Niestety oznacza to czasem
wyrzucenie części wykonanej pracy.
• Przesłanie od razu całej ’gotowej’ pracy z pominięciem etapów wcześniejszych uzgodnień
- może oznaczać niestety konieczność przerobienia większości tekstu.
3
Struktura pracy
Struktura pracy może się różnić w zależności od tematu, jednak poza nielicznymi wyjątkami
ogólna struktura powinna wyglądać następująco:
• Wstęp
2
• Wprowadzenie, ’State of the Art’
• Opis rozwiązania i/lub przyjętej metodologii
• Prezentacja uzyskanych wyników
• Dyskusja i podsumowanie
• Dodatki
Istotne jest, aby w wyraźny sposób rozdzielić część zawierającą informacje z innych źródeł której autorem nie jest dyplomant a jedynie pokazuje znajpomość tematu - od części przygotowanej samodzielnie. W pierwszej części pracy (poza wstępem) generalnie należy udowodnić
swoją wiedzę o danej dziedzinie, natomiast w drugiej opisać swoje osiągnięcia. Praca z reguły
powinna się składać z 4-10 głównych rozdziałów, z których każdy będzie zawierał od kilku do
maksymalnie kilkunastu podrozdziałów.
W dodatkach należy umieścić elementy mniej istotne dla samej treści pracy (listingi, opisy
protokołów, struktury baz itp.)
3.1
Objętość
Jest to standardowe pytanie na które nie ma oczywistej odpowiedzi: “Ile stron powinna mieć
praca dyplomowa?”. Zależy to bardzo od tematu pracy, jednak najczęściej prace inżynierskie
mają ok. 30-60 stron, natomiast magisterskie 50-80 (nie licząc dodatków). Istotne jest aby nie
’pompować’ sztucznie pracy dyplomowej tekstem, bo lepiej będzie ocenione dobre 30 stron niż
’zaśmiecone’ 80. W zasadzie jedynym obszarem w którym nie trzeba się ograniczać to wyniki
eksperymentów - jeżeli w wyniku pracy powstało i można przedstawić dużo wartościowych
wyników (w postaci tabel, wykresów itp.) to jak najbardziej wskazane jest umieszczenie ich
wszystkich w pracy.
3.2
Literatura
Jak w każdej pracy naukowej niezbędne jest odwołanie się do innych źródeł - choćby po to
żeby pokazać że dyplomant zna daną dziedzinę. Choć można korzystać również ze stron internetowych, to generalnie informacje tam zawarte należy traktować z dużą ostrożnością - często
bowiem wiarygodność autorów jest trudna do sprawdzenia. Generalnie w pracy powinny się
znaleźć przede wszystkim odnośniki do literatury oficjalnie publikowanej (książki, czasopisma)
a posiłkować się internetem można w przypadku jeżeli w danym temacie nie ma dostępnych
publikacji.
Co do ilości pozycji bibliograficznych, to znów nie ma tu reguły, jednak można oczekiwać
że przeciętna praca inżynierska potrzebuje ich przynajmniej kilkanaście, a magisterska 20-50.
Wszystkie pozycje bibliograficzne powinny być przywołane w tekście pracy przez odnośnik w
miejscu gdzie przedstawiana jest informacja której dotyczą. Przykład: “..... jak pokazują badania [12], zdecydowana większość użytkowników ...”.
Uwaga! W pracy należy w ogóle unikać podawania informacji które nie zostały pozyskane
ze źródeł, jak np.: “ ... obecnie większość użytkowników korzysta z Windows 7....” (bo ja i
wszyscy moi koledzy takich używamy?). Wszelkie twierdzenia muszą mieć uzasadznienie albo
w badaniach własnych, albo właśnie cytowanych innych publikacjach.
4
Język
Ideałemy byłoby gdyby praca była nie tylko ciekawa, interesująca ale i dobrze napisana - tak aby
czytało się ją z przyjemnością. Niestety szczególnie studenci kierunków technicznych, którzy
3
często przez lata z rezerwą podchodzą do ’aspektów humanistycznych’, potrafią skonstruować
wypowiedzi na których umysł czytającego może nie tylko się potknąć, przewrócić, ale i stracić
już na stałe kontakt z tekstem. Nie da się w tej krótkiej instrukcji opisać jak dobrze konstruować
zdania, stąd jedynie zwrócę uwagę na kilka istotnych aspektów:
• Parafrazując znanego geniusza, “Wszystko powinno być tak proste jak to możliwe ale nie
prostsze” - zdania powinny być proste i precyzyjne, bez nadmiaru ozdobników ale z jasno
i jednoznacznie przekazaną treścią
• Należy unikać zdań zbyt długich i wielokrotnie złożonych. Jeśli zdanie zajmuje sześć
linijek to prawie na pewno należy je podzielić na krótsze...
4.1
Forma narracji
W pracach naukowych generalną zasadą jest użycie strony biernej. Zamiast napisać “... wykonałem aplikację implementującą algorytm X.” należy napisać “... w ramach prac wokonano
algorytm X” lub np. “... został zaimplementowany algorytm X”. Należy przy tym uważać że by
nie tworzyć wspomnianych wcześniej łamańców językowych.
4.2
Użycie słów
Dobór słów powinien być precyzyjny i na odpowiednim poziomie. W związku z tym nie należy
używać kolokwializmów (’websajtów’), slangu (’został zdosowany’) i innych wątpliwych konstrukcji. Żeby ograniczyć rozmiar tekstu dopuszczalne i wskazane jest natomiast stosowanie
skrótów. Raz zdefiniowany skrót można potem używać dowolną ilość razy w dalszym tekście.
Przykład: “Organizacja Open Web Application Security Project (OWASP) ..... OWASP publikuje okresowo....”.
Użycie słów obcych. Jeżeli w tekście konieczne jest użycie słowa lub zwrotu obcojęzycznego
to należy go wyróżnić (np. kursywą) i o ile to możliwe wytłumaczyć. Jeżeli nie istnieje np.
powszechnie akceptowane tłumaczenie danego terminu to jak najbardziej można w całości
tekstu używać słowa orginalnego, choć za każdym razem wyróżniając go np. kursywą. Przykład:
“ Metody odtworzenia ’wstecznego’ niedostępnej informacji (ang. reverse engineering).”
4.3
Stylistyka
Nie ma się co spodziewać że w ostatniej chwili, po latach zaniedbań, uda się komuś znacząco
zwiększyć swoje umiejętności stylistyczne. Dlatego zawsze warto poprosić o pomoc i korektę
np. żonę/dziewczynę (chłopaka) - szczególnie jeżeli ich zdolności w tym zakresie są znacząco
wyższe. A nawet jeśli nie, to i tak wskażą Wam miejsca gdzie być może przekaz nie jest tak
jasny i oczywisty jak Wam się wydawało. W każdym przypadku warto aby przed wysłaniem
pracy (lub części pracy) do oceny ktoś inny ją przejrzał i zwrócił uwagę na ew. błędy.
5
Na zakończenie
Dla tych co dobrnęli do tego miejsca i co ważne zrobili to przed napisaniem pracy: mam nadzieję że informacje tu zawarte pozwolą Wam przygotować prace lepszą a przy tym sprawniej i
z mniejszą ilością ’iteracji’. Wszelkie uwagi i sugestie które pomogą innym mile widziane. Odpowiadając wreszcie na inne często powtarzające się pytanie - ani jako promotor ani recenzent
nie oczekuję dostarczenia pracy w formie wydrukowanej. Wystarczy wersja elektroniczna.
4