Jednym z moich zadań w pracy akademickiej jest opieka nad pracami dyplomowymi i różnego rodzaju

Realizacja prac dyplomowych

Poradnik dla dyplomantów

dr inż. Łukasz Makowski 12 stycznia 2018

J

ednym z moich zadań w pracy akademickiej jest opieka nad pracami dyplomowymi i różnego ro- dzaju projektami, realizowanymi przez studentów. Chciałbym, by tematy prac dyplomowych re- alizowanych na Wydziale Elektrycznym Politechniki Warszawskiej były SMART: ,,specific'' - konkretne, ,,measurable'' - mierzalne w sensie osiągnięcia celu, ,,achievable'' - osiągalne w usta- lonym czasie, ,,relevant'' - istotne na tyle, by później można o nich opowiadać z dumą. Ostatnia literka w skrócie to ,,time-bound'', czyli ograniczone w czasie, co jest niezależnym od nas ale istot- nym wymogiem, któremu trzeba sprostać.

C

hciałbym aby sukcesem była każda praca dyplomowa zrealizowana na Wydziale Elektrycznym Politechniki Warszawskiej. Wielu studentów ma wspaniałe pomysły, znakomitą wiedzę i umie- jętności techniczne. Niestety równie duża grupa ma problemy z zarządzaniem czasem, z realizacją długoterminowego zadania i wytrwałym dążeniem do celu. Promotor ma większe doświadczenie i może znać te problemy z własnego doświadczenia a mając ich świadomość będzie wiedział jak wspierać studentów w ich wysiłkach o uzyskanie dyplomu. Nie jest to łatwe gdy ma się pod opieką kilka osób w tym samym czasie. Jest to jeden z powodów, dla których powstał niniejszy tekst.

B

yć może momentami tekst będzie wydawał Ci się surowy i ostry ale nie przejmuj się! Jeśli to czytasz, to zapewne masz już odpowiedni poziom zaangażowania i chęci by pracę dyplomową zrealizować w sposób jak najlepszy. Oczywiście, wszystko na miarę własnych sił i możliwości, które jednak są zapewne większe, niż przypuszczasz. Jestem przekonany, że chcesz o swojej pracy dyplomowej mówić później w kategoriach sukcesu i właśnie w ten sposób ją wspominać. Skoro tak, to już teraz stoisz po ,,jasnej stronie mocy'' a sukces jest na wyciągnięcie ręki.

T

rzymam kciuki, że podejmując współprace z promotorem obaj z równym zaangażowaniem będziecie dążyli do tego, by praca dyplomowa była Twoim sukcesem, który osiągniesz ze spokojem i w ter- minie. Dlatego powstał poniższy tekst - bym mógł pomóc sobie i Wam, drodzy Studenci, w spraw- nym, skutecznym i rzetelnym sprostaniu temu wyzwaniu.

Łukasz Makowski

1 Wstęp

Niniejszy tekst jest subiektywną wizją tego, jak powinien przebiegać proces re- alizacji pracy dyplomowej. Powstał na bazie dekady doświadczeń w pracy dydak- tycznej, co obejmuje wypromowanie 36 dyplomantów na Wydziale Elektrycznym Politechniki Warszawskiej. Dotyczy głównie prac inżynierskich ale znajduje też za- stosowanie do prac magisterskich, z uwzględnieniem różnic takich jak: dłuższe ter- miny i większa złożoność, obejmująca aspekty naukowo-badawcze. Być może inni promotorzy stosują odmienne wytyczne, dlatego zawsze warto skonsultować się z własnym opiekunem pracy dyplomowej.

Zauważone błędy lub uwagi dotyczące tego dokumentu można zgłaszać na mój adres e-mail:lukasz.makowski)ee.pw.edu.pl.

1.1 Dlaczego warto pisać pracę dyplomową?

Chociaż niniejszy poradnik nie jest miejscem na polemikę dotyczącą sensowności pisania prac dyplomowych to zakłada, że praca dyplomowa zarówno inżynierska jak i magisterska nie jest złem koniecznym ani nie jest kolejnym projektem, jakich wiele podczas studiów. Jest to ukoronowanie pewnego etapu edukacji i możliwość zaprezentowania zdobytych umiejętności szerszemu gronu osób.

Według jednego z licznych poradników pisania prac dyplomowych, które można znaleźć w Internecie¹, celem pracy dyplomowej jest to, by studentka lub student zdobyli kilka umiejętności, takich jak:

1. samodzielność w wyborze problemu, 2. zdolność oceny wagi problemu,

3. zdolność do zaproponowania metody rozwiązania problemu,

4. zdolność do zaimplementowania metody w rzeczywistych warunkach, 5. umiejętność szerokiego wykorzystania wiedzy ze studiów.

Powyższe uwagi pochodzą od prof. Tomasza Szapiro, rektora Szkoły Głównej Han- dlowej w Warszawie, w kadencji 2012-2016.

Warto też spojrzeć na to, jakie podejście do prac dyplomowych mają czołowe uczelnie światowe takie jak:Harvard,MIT,PrincetonczyOxford.

1J. Growiec, T. Szapiro, „Wskazówki dotyczące pisania prac licencjackich i magisterskich”, url: https://web.sgh.waw.pl/~mlewan1/Site/Seminarium_files/Wskazowki_1.pdf, dostęp uzyskano:

2017-12-21

1.2 Zakres, autor i „własność” pracy dyplomowej

Sugeruję by prace dyplomowe były pisane indywidualnie, nawet jeśli temat łączy się z inną pracą, realizowaną przez inną osobę, w warstwie merytorycznej. Dzięki temu unika się konfliktów kompetencji, dyskusji o tym, kto powoduje opóźnienie oraz końcowego problemu związanego z oceną wkładu poszczególnych autorów w daną pracę. Z drugiej strony trzeba pamiętać, że praca dyplomowa powinna stanowić spójną całość. Oznacza to, że nie powinna odnosić się do pracy powstającej równole- gle w tym samym czasie. Prace czysto sprzętowe są możliwe ale w obecnych czasach raczej trudno uciec od mikrokontrolera lub mikroprocesora, które bez działającego na nich programu stanowią tylko kawałek krzemu. Przykłady:

• Dwóch studentów realizuje jedno urządzenie przy czym jeden z nich buduje sprzęt a drugi tworzy oprogramowanie tej, jeszcze nie powstałej, płytki. Nie można na tym etapie stwierdzić, że którakolwiek z tych prac ma sens i zakoń- czy się sukcesem. Nowe urządzenie musi stanowić spójną całość zarówno pod względem sprzętowym jak i programowym czyli po prostu działać i robić to, co powinno. Stąd taka sama zasada powinna dotyczyć tekstu pracy dyplomowej, która powinna mieć jednego autora.

• Student w ramach pracy magisterskiej realizuje nowe oprogramowanie dla urządzenia, która zarówno jako PCB jak i pewne oprogramowanie powstało w ramach jego pracy inżynierskiej. Może wystąpić problem z odróżnieniem i oceną tego, co powstało w ramach pracy inżynierskiej a co jest nowym mate- riałem stanowiącym przedmiot pracy magisterskiej. Głównym wątkiem pracy powinno być zatem to, co jest nowe i odmienne względem wcześniejszego roz- wiązania.

• Student w ramach pracy dyplomowej realizuje oprogramowanie dla urządze- nia, które powstało w ramach pracy dyplomowej napisanej przez inną osobę lub po prostu na module rozwojowym dostępnym komercyjnie. Podobnie jak w poprzednim przykładzie należy zwrócić uwagę na to by zakres pracy stano- wiący indywidualny, autorski wkład dyplomanta był wyraźnie widoczny na tle bazowego rozwiązania.

Realizacja pracy sprzętowo-programowej w porównaniu z pracą czysto progra- mistyczną nie jest ani łatwiejsza ani trudniejsza. Wiele zależy od preferencji da- nej osoby, jej celów życiowych i zawodowych. W pracy, w której opracowane zo- stały sprzęt oraz dedykowane dla niego oprogramowanie, widać horyzonty myślowe i spektrum umiejętności dyplomanta. W pracy czysto programistycznej widać po- ziom umiejętności w tej konkretnej dziedzinie, jaką jest tworzenie oprogramowa- nia.

Promotor wspiera swego podopiecznego w realizacji pracy dyplomowej poprzez sugestie i pomysły dotyczące kierunku rozwoju pracy oraz poprzez wprowadzane do tekstu poprawki. Wkład promotora w pracę z pewnością jest aczkolwiek nie- wielki i trudny do oszacowania. Dlatego promotor nie jest ujęty na liście autorów ani nie należy go umieszczać w ewentualnych podziękowaniach. Prawa Uczelni do pracy dyplomowej to pierwszeństwo do jej opublikowania ale tylko w ciągu 6 mie- sięcy od obrony. Po tym czasie również autor może ją opublikować. Uczelnia może korzystać z dorobku twórczego powstałego w ramach procesu dydaktycznego, w ra- mach realizacji zadań statutowych, co oznacza na przykład, że oprogramowanie powstałe w ramach pracy dyplomowej może być wykorzystywane w laboratoriach uczelni i w realizacji dydaktyki.

1.3 Podstawy współpracy z promotorem

W dalszej części dokumentu zaproponowany jest harmonogram realizacji pracy dy- plomowej ukierunkowany na taką, w której należy zaprojektować i wykonać pe- wien układ elektroniczny i/lub stworzyć autorskie oprogramowanie. Harmonogram przedstawiony jest w postaci wykresu Gantta oraz terminarza. Stanowią one szablon oraz zestaw wskazówek, których nie należy traktować bezkrytycznie a dostosowy- wać do konkretnej pracy dyplomowej. Sugeruję uzgadniać z promotorem taki har- monogram by obie strony wiedziały, jakie są wzajemne oczekiwania i cele szczegó- łowe. Fundamenty współpracy w kontekście terminowości jej realizacji mogą być takie, jak w poniższej ramce.

 Brak kontaktu przez ponad dwa miesiące uważam za brak postępów w pracy.

 Nie zrealizowanie „punktów kontrolnych” w terminie uważam za brak postępów w pracy.

 W przypadku braku postępów w pracy, utrzymującego się przez ko- lejne dwa miesiące, współpraca może zostać zakończona a temat wróci do puli tematów wolnych.

Mimo przyjęcia powyższych założeń, trzeba uznać, że w trakcie realizacji pracy mogą pojawić się opóźnienia lub odstępstwa od ustalonego harmonogramu. Mogą one być spowodowane na przykład wyjątkowym zakresem i charakterem konkret- nej pracy dyplomowej, zmianą sytuacji życiowej Dyplomanta lub innymi powodami, które teraz nie są znane. Tu pojawia się jedna z istotniejszych zasad - należy po- zostawać z promotorem w kontakcie i otwarcie informować o ewentualnych proble- mach.

1.4 Komunikacja z promotorem

Być może Twój promotor preferuje wyłącznie kontakty via e-mail. Wówczas dobrym pomysłem jest dodawanie na początku tytułu wiadomości „[DYPLOM]”, co znacznie ułatwia odnajdywanie takiej poczty i zarządzanie nią. Wysyłanie kolejnych wersji pracy w postaci plików mających po kilka lub więcej MB jest jednak metodą sprzed dekady i nie przystaje do współczesnych realiów Internetu. Jeśli mamy do dyspo- zycji tylko młotek, to każdy problem wygląda jak gwóźdź. Poczta elektroniczna po- winna służyć do uzgodnień na przykład spotkań, do krótkiej korespondencji a nie do wymiany i wersjonowania plików.

Być może promotor korzysta z systemu obsługi dziekanatu takiego jak ISOD². Jest to bardzo dobre rozwiązanie pośrednie między pocztą elektroniczną a profesjo- nalnym zarządzaniem projektem: pozwala załączać pliki, robić notatki i analizować historię zmian. ISOD niestety nie informuje o aktualizacji załączonych w nim pli- ków, dlatego dobrze jest wysłać informacyjny e-mail samodzielnie.

Proponuję podczas realizacji pracy korzystać ze środowiska do zarządzania pro- jektami. Na czas realizacji pracy dyplomowej oferuję moim dyplomantom dostęp do serwisu Redmine. Jest to dodatkowe doświadczenie, które może zaprocentować w przyszłej pracy zawodowej. Niezależnie od możliwości technicznych i wybranych sposobów współpracy, należy skrupulatnie dokumentować postępy i napotykane problemy, gdyż znacznie ułatwia to późniejsze pisanie pracy.

Dla większych projektów informatycznych (programistycznych) sugeruję użycie repozytorium na bazie oprogramowania takiego jak git (np.: naGitHub).

Najlepszą formą kontaktu jest regularne spotkanie z promotorem i krótka roz- mowa o postępach w pracy. Wymiana informacji w trakcie takiego spotkania jest dużo bardziej wartościowa i z pewnością szybsza niż seria e-maili. Jedyne o czym należy pamiętać to o robieniu notatek w trakcie spotkania lub tuż po jego zakończe- niu. Promotor, który po raz kolejny daje dyplomantowi te same sugestie lub popra- wia te same błędy nie jest zadowolony z tak układającej się współpracy. Z drugiej strony promotor, który ciągle zmienia oczekiwania i na przykład wraca do pierwot- nych pomysłów, które sam skrytykował, nie jest pomocny dla swego podopiecznego.

Dlatego notatki to dobry pomysł. Jednak obowiązek ich tworzenia i ciężar tej do- datkowej pracy powinien leżeć po stronie dyplomanta między innymi dlatego, że dzięki tym notatkom może się ukształtować treść jego pracy dyplomowej i zawarte w niej przyczynowo-skutkowe rozważania.

2Internetowy System Obsługi Dziekanatu - webserwis dla studentów i pracowników uczelni, po- wstały na Wydziale Elektrycznym Politechniki Warszawskiej

1.5 Wybór narzędzia do złożenia pracy

Dobrze by było, gdyby praca została złożona (w sensie składu tekstu a nie złożenia do obrony) za pomocą pakietu L^ATEX lub pokrewnego. Szablony takiej pracy są do- stępne a oprogramowanie darmowe. Oczywiście łatwiej zacząć pisanie z użyciem pakietu biurowego ale w dłuższej perspektywie wybór systemu składu tekstu, ja- kim jest L^ATEX, daje istotne korzyści. Przede wszystkim nie trzeba martwić się o for- matowanie pracy, nie trzeba dbać o odstępy, o stopień pisma, o spójność czcionki i tym podobne rzeczy, gdyż są one zarządzane automatycznie. Z pliku źródłowego generowany jest plik PDF.

W L^ATEX edycja wzorów jest rozwiązana rozsądnie - identycznego stylu używa Wikipedia. Osiągany efekt jest najwyższej jakości. Trudno to samo uzyskać z uży- ciem pakietów biurowych. Przykład:

{

∂ΩE· dS = 1 ε0

y

ΩρdV ∇ · E = ρ

ε0

(1) {

∂ΩB· dS = 0 ∇ · B = 0 (2)

z

∂ΣE· dℓ = −d dt

x

ΣB· dS ∇ × E = −∂B

∂t (3)

z

∂ΣB· dℓ = µ0

x

ΣJ· dS + µ0ε0

d dt

x

ΣE· dS ∇ × B = µ0

(

J + ε₀∂E

∂t )

(4) Jeśli promotor nie przyjmuje nic innego niż dokumenty z jego ulubionego edy- tora tekstu to cóż, trudno. Przynajmniej, jako dyplomant, nie będziesz samemu cierpieć z powodu: przesuwających się rysunków, niespójnego z treścią numerowa- nia w bibliografii, kiepskiej kontroli wyrównania akapitów, niedopasowania świa- tła międzywierszowego i międzywyrazowego, i tym podobnych problemów.

Do edycji pliku źródłowego polecam dedykowany dla L^ATEXa otwartoźródłowy i darmowy edytor Kile. Właśnie w tym edytorze powstał niniejszy tekst.

Rysunek 1: Edycja dokumentu w Kile

Rysunek2:PrzykładowydiagramGanttadlapracydyplomowej,którazaczęłabysięwczerwcu2018

2 Harmonogram

CZERWIEC

1. Ustalenie z promotorem tytułu i zakresu pracy dyplomowej. Efektem tego jest temat sformułowany w ISOD.

2. Początek etapu „Opracowanie koncepcji rozwiązania”.

3. Rozpoczęcie analizy istniejących, podobnych rozwiązań (ang. „state of the art”).

4. Rozpoczęcie wyszukiwanie potrzebnych materiałów podzespołów, modułów, bibliotek programistycznych itp. - „lista potrzeb”.

LIPIEC

1. Dokończenie analizy istniejących rozwiązań.

2. Dokończenie „listy potrzeb”.

3. Punkt kontrolny: Raport wstępny - „Koncepcja rozwiązania (...)”, czyli kilku- stronicowy (max. 6 stron) raport wstępny na podstawie powyższych dwóch zadań. Stanowi zalążek dla tekstu pracy dyplomowej. Raport zawiera infor- macje techniczne - konkretne i aktualne ale nie jest częścią opisową - teore- tyczną i ogólną.

4. Początek etapu „Implementacja rozwiązania”.

5. Rozpoczęcie wdrażania istniejącego oprogramowania (opcja 1) z ewentualnym nanoszeniem potrzebnych zmian na „liście potrzeb”.

6. Rozpoczęcie projektowania ideowego i PCB (opcja 2) z ewentualnym nanosze- niem potrzebnych zmian na „liście potrzeb”.

SIERPIEŃ

1. Kontynuacja wdrażania istniejącego oprogramowania (opcja 1).

2. Kontynuacja projektowania ideowego i PCB (opcja 2).

3. Rozpoczęcie realizacji autorskiego oprogramowania (może zacząć się później - w zależności od typu pracy).

WRZESIEŃ

1. Dokończenie wdrażania istniejącego oprogramowania (opcja 1).

2. Dokończenie projektowania ideowego i PCB (opcja 2).

3. Rozpoczęcie montażu sprzętu (opcja 2).

4. Kontynuacja realizacji autorskiego oprogramowania.

PAŹDZIERNIK

1. Dokończenie montażu sprzętu.

2. Punkt kontrolny: „Zapewnienie podstaw do realizacji autorskiego oprogramo- wania”.

3. Kontynuacja realizacji autorskiego oprogramowania.

4. Początek etapu: „Napisanie tekstu pracy”.

5. Rozpoczęcie pisania tekstu pracy dyplomowej w zakresie części opisującej osiągnięcia autorskie.

LISTOPAD

1. Kontynuacja realizacji autorskiego oprogramowania.

2. Kontynuacja pisania tekstu pracy dyplomowej w zakresie części opisującej osiągnięcia autorskie.

3. Rozpoczęcie pisania tekstu pracy dyplomowej w zakresie części teoretycznej.

GRUDZIEŃ

1. Dokończenie realizacji autorskiego oprogramowania.

2. Dokończenie pisania tekstu pracy dyplomowej w zakresie części opisującej osiągnięcia autorskie.

3. Punkt kontrolny: „Ukończenie pracy jest możliwe”.

4. Dokończenie pisania tekstu pracy dyplomowej w zakresie części teoretycznej.

5. Rozpoczęcie pisania tekstu pracy dyplomowej w zakresie pozostałych części:

wstęp, podsumowanie itd.

STYCZEŃ

1. Dokończenie pisania tekstu pracy dyplomowej w zakresie pozostałych części:

wstęp, podsumowanie itd.

2. Rozpoczęcie i ukończenie niemerytorycznej korekty pracy (tzw. „formatowa- nie”) oraz zapewnienie zgodności z wytycznymi JM Rektora Politechniki War- szawskiej (strona tytułowa, oświadczenie, streszczenia w języku polskim i ję- zyku obcym, płyta CD).

3. Punkt kontrolny: „Złożenie pracy dyplomowej”. Uwaga! Żeby złożyć pracę dy- plomową nie trzeba mieć absolutorium! Kolejność tych dwóch czynności jest dowolna. Absolutorium jest potrzebne by procedować dokumenty w dziekana- cie a tym samym by przystąpić do egzaminu dyplomowego. Można więc złożyć pracę w terminie - np.: 25 stycznia, następnie w sesji zimowej uzyskać ostatni wpis a obronić się po jego uzyskaniu.

4. Spełnienie formalności: druk, oprawa, wniosek o egzamin, dostarczenie do- kumentów do sekretarza obron itp.

LUTY:

1. Egzamin dyplomowy.

3 Osiągnięcia

Praca dyplomowa jest przez niektórych sprowadzana do roli trochę bardziej skom- plikowanego projektu. Gdyby jej wykonanie traktować tak jak projekt, to można też wyznaczyć kilka „osiągnięć”, które można zdobyć:

1. Ustal temat i cele pracy dostatecznie starannie, by później nie trzeba było ich zmieniać.

2. Kolejne etapy rozpoczynaj i kończ zgodnie z planem - na przykład takim, jaki jest przedstawiony na następnych stronach.

3. Utrzymuj komunikację z promotorem i regularnie konsultuj realiza- cję pracy.

4. Trzymaj się zasady: najpierw zrobić a później opisywać.

5. Sprawdź tekst pracy pod względem ortografii ale pamiętaj, że auto- matyczne sprawdzanie pisowni czasem sobie nie razi.

6. Poproś kogoś z grona bliskich lub znajomych, nie mającego wiedzy technicznej, by przeczytał Twój tekst i opowiedział Ci, co z niego zro- zumiał.

7. Złóż pracę dyplomową na tyle wcześnie, by spokojnie wypełnić pro- cedury niezbędne przed egzaminem dyplomowym.

8. Wykorzystaj system składu tekstu L^ATEX.

9. Wykorzystaj narzędzie do zarządzania projektami.

10. Pliki pracy trzymaj w repozytorium i rób kopie zapasowe.

4 Uwagi dotyczące tekstu pracy

Szablon pracy w L^ATEX można znaleźć na stronieISOD-Portal, w części „[DZIEKA- NAT] Prace dyplomowe” pod nazwąPD_202 LATEX_dyplom.zip. Znajduje się tam teżprzykładowy plik PDF. Jest to dobry punkt wyjścia do realizacji własnej pracy dyplomowej na Politechnice Warszawskiej. Osoby, które z tej możliwości skorzy- stają w zasadzie nie muszą się martwić o poprawne „sformatowanie” tekstu, gdyż powstały dokument będzie zgodny z wytycznymi JM Rektora Politechniki War- szawskiej odnośnie tego, jak mają wyglądać prace dyplomowe. Kompilacja jest moż- liwa za pomocą pdflatex, programu dystrybuowanego w ramach pakietu TeX Live.

Jest to wolne i otwarte oprogramowanie dostępne dla różnych systemów, w tym dla systemów z rodziny GNU/Linux, gdzie instalacja tego pakietu jest banalnie prosta.

4.1 Aspekty techniczne

Strona tytułowa Modyfikujemy stronę tytułową dostosowując ją do konkretnej pracy. Prace dyplomowe zazwyczaj nie mają konsultantów dlatego usuwamy ten element.

Druk dwustronny Praca ma być wydrukowana dwustronnie. W pierwszej linii pliku praca_dyplomowa.tex zmieniamy openany na openright. W pierwszej linii pliku streszczenia.tex zamieniamy newpage na cleardoublepage oraz wstawiamy jeszcze jedną komendę cleardoublepage tak, by oddzielić streszczenia w różnych językach na osobne strony. Po tych poprawkach wszystkie „ważne” rzeczy będą się zaczynały od stron nieparzystych, które powinny znajdować się po prawej stronie w druku dwustronnym. Taki układ wygląda dobrze, gdy wydrukowaną pracę otwo- rzymy. Niniejszy dokument nie jest zgodny z tą zasadą ale ma to uzasadnienie dopóki poszczególne rozdziały są bardzo krótkie.

Długość pracy Praca inżynierska powinna mieć około 40-60 stron a praca ma- gisterska około 80-100 stron. Oczywiście wiele zależy od tego, co składa się na jej treść, ile jest rysunków, ile zostało pustych przestrzeni.

Wiszące znaki Pojedyncze literki na końcach wierszy nie są zgodne z polskim sposobem składania tekstów, wyglądają źle i utrudniają płynne czytanie. Dlatego łączymy je z następującymi po nich słowami za pomocą tak zwanej „twardej spacji”.

W L^ATEX używa się do tego znaku tyldy: Hobbit, czyli tam i~z~powrotem.

4.2 Treść

Na treść pracy składa się tekst oraz struktura tego tekstu. Nawet dobry tekst po- zbawiony właściwej struktury będzie oceniony źle. Dobra i czytelna struktura pracy pozwala łatwiej przyswoić nawet trudny i lakoniczny przekaz.

Styl W pracach inżynierskich i magisterskich powinien być stosowany styl na- ukowy. Oznacza to przede wszystkim konieczność zachowania obiektywizmu. W pra- cach inżynierskich wnioski są formułowane na podstawie doświadczeń empirycz- nych, które mogą obejmować wykonanie jakiegoś urządzenia lub oprogramowania.

Prace magisterskie muszą stać pod tym względem nieco wyżej i powinny stosować metodę naukową czyli formułowania hipotez i wyciągania wniosków na podsta- wie obserwowalnych faktów. Niedopuszczalne jest wybiórcze traktowanie wyników i dopasowywanie faktów do głoszonych teorii.

Unikamy przymiotników oceniających („ładnie napisany kod”) oraz hiperboli („ogromna biblioteka wymaga przepastnych zasobów dyskowych”). Jednak nie re- zygnujemy z przymiotników zupełnie: „kod jest czytelny”, „kompilacja wymaga du- żej przestrzeni dyskowej”. Ocenę warto uszczegółowić i ją uzasadnić: „Kod jest czy- telny dzięki licznym komentarzom.”, ”Kompilacja wymaga dużej przestrzeni dys- kowej - ponad 40 GB.”. Oczywiście pierwsze zdanie nadal jest zdaniem ocenia- jącym ale zostało poparte pewnym uzasadnieniem, które może stanowić przed- miot merytorycznej dyskusji. Zdanie drugie również jest oceniające ale zostało po- parte pewną mierzalną wartością. Oczywiście już niedługo metodologia pisania programów może się zmienić a wymieniona przestrzeń dyskowa może być uznana za śmiesznie małą, jednak autor opisuje sytuację znaną ludziom mu współczesnym, aktualny stan wiedzy.

Piszemy zdania a nie równoważniki zdań. Zmiana szyku, w stylu mistrza Yody („Niesamowity Wszechświat jest.”) nie wprowadza stylu naukowego a wręcz prze- ciwnie, czyni tekst śmiesznym i trudnym w odbiorze. Więcej o stylu naukowym można znaleźć w polskiejWikipedii.

Forma osobowa W pierwszej osobie można pisać wyłącznie w kilku miejscach:

oświadczenie (to oczywiste), podziękowania, fragment podsumowania. Zdecydowaną większość tekstu pracy piszemy używając formy bezosobowej, co ułatwia zachowa- nie obiektywizmu. W podsumowaniu można umieścić akapit „personalny”, w któ- rym można krótko omówić jak realizacja danej pracy dyplomowej przyczyniła się do rozwoju osobistego autorki/autora.

Struktura pracy W ogólności każda praca ma co najmniej cztery merytorycznie istotne fragmenty: wstęp, rozdział zawierający powszechnie znaną wiedzę teore- tyczną, rozdział zawierający opis indywidualnych osiągnięć autorskich - uzyska- nych w ramach realizacji pracy dyplomowej, rozdział podsumowujący pracę.

Trudne słowa Pary trudnych słów: liczba (policzalne) - ilość (niepoliczalne), funk- cjonalność (cecha, jak na przykład wydajność) - funkcja (możliwość realizacji cze- goś, jak printf)³, metodologia (nauka) - metodyka (zasady postępowania).

Streszczenie Streszczenie opisuje tekst pracy dyplomowej, wskazuje najistot- niejsze cele oraz omawia z jakich rozdziałów składa się tekst. Nie przedstawiamy tu realizacji pracy, na co składa się przecież cały wachlarz działań. W streszczeniu używany jest czas teraźniejszy: „W rozdziale 5 omówione jest badanie działania urządzenia, zbudowanego w ramach niniejszej pracy, w warunkach rzeczywistych oraz zaprezentowane są charakterystyki uzyskane w wyniku tych badań”.

Spis treści Spis treści powinien pomagać a nie przeszkadzać w znalezieniu inte- resującego fragmentu. Numerowanie sięga co najwyżej trzeciego poziomu a suge- ruję ograniczyć je do dwóch. W spisie treści można umieścić rozdziały i podrozdziały z innym zagłębieniem, niż są w tekście. Czyli w treści są na przykład podrozdziały trzeciego poziomu a w spisie jedynie do drugiego.

Wstęp Pierwsze wrażenie można zrobić tylko raz. Wstęp w dużej mierze decy- duje o dalszym odbiorze pracy. Jest to miejsce, gdzie należy zapowiedzieć cele pracy i bardzo ogólnie przedstawić tło oraz powody podjęcia tematu. Rozdział ten nie jest tym samym co streszczenie! Używamy tu trybu przypuszczającego i czasu przy- szłego: „Można podejrzewać, że użycie mikrokontrolera z akceleracją obliczeń sumy kontrolnej pozytywnie wpłynie na wydajność komunikacji. Zostanie to przebadane w ramach niniejszej pracy”. Rozdział ten powinien obejmować nie więcej niż 5%

objętości pracy, czyli około 2-3 strony w przypadku pracy inżynierskiej i 4-5 w ma- gisterskiej.

Rozdziały teoretyczne Rozdziały teoretyczne służą do głębszego wprowadzenia czytelnika w temat, pokazania aktualnego stanu wiedzy i znanych rozwiązań. Czy- tający powinien mieć szansę właśnie dzięki rozdziałom teoretycznym „spojrzenia na świat” tak, jak widzi to piszący. Jest to też ta część pracy, gdzie należy wskazać

3Funkcje (metody, klasy, moduły, itp.) w programie są policzalne i można podać ich konkretną liczbę a funkcjonalność programu, choć też mierzalna, to może być określona jedynie jakościowo (wy- soka, niska, obejmuje 90% założeń, itp.).

odniesienia bibliograficzne. Większość odnośników powinno znajdować się właśnie w tej części. Rozdziały teoretyczne nie powinny stanowić więcej niż 45% objętości pracy, czyli zaledwie 18-27 stron w pracy inżynierskiej i 36-45 w magisterskiej.

Rozdziały autorskie W tych rozdziałach znajduje się meritum pracy. Pierw- szym takim rozdziałem może być omówienie wyboru sprzętu lub bibliotek progra- mistycznych potrzebnych do realizacji pracy. Pozwala to płynnie przejść od roz- działów teoretycznych do opisu indywidualnego rozwiązania, stanowiącego temat pracy. Powinny zajmować część pracy co najmniej tak dużą, jak rozdziały teore- tyczne.

Rozdział podsumowujący Jest on miejscem gdzie należy przywołać główne osią- gnięcia uzyskane podczas realizacji pracy. Nie jest tym samym co streszczenie! Jeśli wszystko w realizacji pracy dyplomowej poszło zgodnie z planem, to sugeruję umie- ścić zdanie w stylu: „Praca została zrealizowana zgodnie z zamierzeniami i wszyst- kie zaplanowane cele zostały osiągnięte”. Jeśli nie wszystko się udało, to cóż - może udała się większość? A jeśli coś się nie udało, to być może wiadomo dlaczego? Wie- dza o przyczynach porażki może być równie cenna jak sukces - tak przecież rozwija się nauka i technika.

Początki i końce rozdziałów Pomiędzy następującymi po sobie rozdziałami i podrozdziałami powinna być więź łączących je myśli, którą roboczo nazwijmy „kle- jem”. Ułatwia to odbiór pracy i łatwiej do czytania takiej pracy wrócić. Można ten cel osiągnąć przez krótkie akapity na końcach lub początkach rozdziałów.

Przykład takiego połączenia na końcu rozdziału: „Powyżej zostały omówione ogólne własności i użycie biblioteki OpenSSL, której wykorzystanie w oprogramo- waniu systemu wbudowanego, realizowanego w ramach niniejszej pracy, jest omó- wione w kolejnym rozdziale”. Przykład początku rozdziału: „Podzespoły omówione w poprzednim rozdziale znalazły zastosowanie w projekcie autorskiego systemu mikroprocesorowego sterowania mobilnym systemem pomiarowym, który będzie zaprezentowany na kolejnych stronach”. Nie należy tego nadużywać - jeśli jeden z rozdział ma na końcu „klej”, to kolejny nie powinien go mieć na początku.

Tekst w rozdziałach numerowanych W każdym rozdziale i podrozdziale nu- merowanym musi znaleźć się jakiś tekst, choćby był to jeden akapit opisujący to, co czytelnik znajdzie w podrozdziałach i dalszych akapitach. Niedopuszczalne jest otwieranie rozdziału numerowanego i zaraz pod nim podrozdziału numerowanego:

„1. Rozdział -> 1.1. Podrozdział -> Treść”. Prawidłowa struktura to: „1. Rozdział ->

Treść -> 1.1. Podrozdział -> Treść”.

Bibliografia Odniesienia literaturowe w pracy dyplomowej pozwalają pokazać zorientowanie dyplomanta w dziedzinie badań, w której mieści się temat jego pracy.

Generalnie nie stosujemy cytowania w taki sposób, jak robi się to w naukach hu- manistycznych. Czyli nie kopiujemy tekstów z innych źródeł używając cudzysłowu, chyba że jest to solidnie uzasadnione. Takiego rodzaju cytowanie może w pracy wystąpić raz, jako myśl przewodnia dalszych rozważań. Odwoływanie się do lite- ratury w naukach technicznych ma na celu wskazanie wcześniej istniejących, do- datkowych materiałów, które umocowują rozważania w istniejącym stanie wiedzy.

Literaturę przywołujemy w tym akapicie, który do danej pozycji bibliograficznej można odnieść. Nie przywołujemy literatury w tytułach rozdziałów. Każda z pozy- cji bibliograficznych musi być przywołana w treści pracy.

Formatowanie bibliografii i jej przywoływanie w treści jest bardzo proste, jeśli korzystamy z L^ATEX. Można się wspomóc dodatkowym, również darmowym i po- wszechnie dostępnym narzędziem o nazwie Bibtex.

Źródła bibliograficzne W pracy dyplomowej należy powoływać się na podręcz- niki akademickie, książki i artykuły naukowe. Można powoływać się na prasę bran- żową i specjalistyczną a w tym noty katalogowe, przewodniki programistyczne, do- kumentację bibliotek i oprogramowania oraz inne materiały o charakterze tech- nicznym. Należy unikać prasy i książek popularnonaukowych. Nie można powoły- wać się na materiały wtórne takie jak Wikipedia ani takie, których weryfikacja jest problematyczna jak blogi i prywatne strony internetowe. Jednak, jeśli materiały są dostępne w Internecie to dobrze jest podać adres w postaci „url: tutaj adres”. Zda- rzyło się wielokrotnie, że w czasie pisania pracy pod wskazanym adresem domnie- mane materiały przestały być widoczne. Dlatego należy dodać formułkę „dostęp uzykano: data”.

Studenci Politechniki Warszawskiej mający konto biblioteczne mogą uzyskać dostęp do licznych książek i artykułów naukowych on-line. W tym celu odwiedzamy stronę Biblioteki Głównej, gdzie pod polem wyszukiwania znajdujemy odnośnik

“Lista e-baz”. Tam znajdziemy listę wydawców i baz tekstów naukowych. Dla stu- dentów Wydziału Elektrycznego szczególnie polecam trzy z nich:

1. “IEEE/IEE Electronic Library” - czasopisma z branży elektrycznej, elektro- nicznej i informatycznej oraz standardy IEEE.

2. “ACM Digital Library” - czasopisma informatyczne.

3. “Science Direct on Line / na serwerze Wydawcy” - szeroki zakres dziedzin naukowych.

Plagiatowanie Problem plagiatowania tekstów na kierunkach technicznych jest rzadko spotykany, ze względu na ciągły postęp tych dziedzin wiedzy oraz unikato- wość tematów. Tym niemniej na Politechnice Warszawskiej od wielu lat funkcjo- nuje system antyplagiatowy a cyfrowe wersje prac są umieszczane w archiwum.

Zapewne nie trzeba zatem nikogo przestrzegać przed bezprawnym kopiowaniem cudzych tekstów, gdyż jeśli do tego dochodzi to w sporadycznych przypadkach wy- nikających raczej z nieświadomości iż „tak się nie robi”.

Niestety, inaczej ma się sprawa z rysunkami. Autorzy często „zapominają”, że te same zasady dotyczą zarówno tekstów jak i obrazów graficznych, gdyż zarówno jedne jak i drugie stanowią „dzieła” w rozumieniu prawa⁴. Z praktyki wiadomo, że umieszczanie rysunków w pracy sprawia wiele problemów i dlatego podzieliłem to zagadnienie na kilka mniejszych, przedstawionych w następnym podrozdziale.

4.3 Grafika

Graficzna strona pracy może całkowicie odmienić jej odbiór przez czytelnika i ocenę przez recenzenta. Jednak praca nie może stać się galerią obrazków. Trzeba umieć wyważyć ich ilość tak, by były ilustracją tekstu. Rysunki nie stanowią wyjaśnienia same w sobie, gdyż to jest rolą tekstu pracy. Do każdego rysunku umieszczonego w pracy należy odnieść się w tekście, podając jego numer.

Na rysunku stopień pisma (wielkość czcionki) powinna być taka, jak w podpi- sie pod tym rysunkiem. W rysunku należy wyważyć światło (margines) wokół za- sadniczej jego części. Zbyt duże światło od razu wywołuje wrażenie, iż dyplomant chciał sztucznie zwiększyć liczbę stron swojej pracy. Nie należy też przesadzać z po- większaniem fotografii. Makrofotografie układów elektronicznych mogą być bardzo ładne ale zazwyczaj niczego do pracy nie wnoszą. Zatem zdjęcie płytki PCB powinno być w skali 1:1 lub niewiele większe niż w rzeczywistości. Zakładamy, że powsta- jące w ramach pracy dyplomowej płytki będą miały krawędzie nie większe niż kil- kanaście centymetrów. Dobrze jest umieścić jakiś przedmiot dający odniesienie do rzeczywistej skali, tak jak na przykład: moneta, długopis, linijka.

Rysunki wykonane samodzielnie Gdy rysunki pod względem pomysłu i wy- konania są autorskim opracowaniem to taka sytuacja jest idealna pod względem prawnym. Wówczas nie umieszczamy w podpisie rysunku tekstu „praca własna”.

Autor jest wskazany na okładce a więc nie ma potrzeby stwierdzać tego, co jest oczy- wiste. Rysunek wykonany samodzielnie może być wzorowany na innym i wówczas

4Zastrzegam, że nie jestem prawnikiem i nie udzielam porad prawnych a jedynie dzielę się wiedzą i doświadczeniem, w zakresie li tylko prawidłowego realizowania pracy dyplomowej. Jeśli masz wąt- pliwości dotyczące niniejszych zagadnień, to zapytaj kogoś, kto takich porad prawnych może udzielić.

należy umieścić zastrzeżenie: „Opracowano na podstawie (…)”. Granice między in- spiracją, wzorowaniem się a bezwstydnym kopiowaniem pomysłu są dość trudne do określenia, warto więc uważać. Do wykonania rysunków polecam programy do grafiki wektorowej, takie jak dostępny dla wielu systemów, darmowy, otwartoźró- dłowyInkscape.

Domena publiczna Generalna zasada jest taka, że wszystkie dzieła od momentu ich powstania są chronione prawem autorskim. Jednak w naszej obecnej sytuacji prawnej, w 70 lat po śmierci autora prace przechodzą do tak zwanej „domeny pu- blicznej” a ich ochrona prawnoautorska ustaje, przynajmniej w sferze praw mająt- kowych. Można więc używać bardzo starych obrazków, o ile to komuś jest potrzebne.

Jedno z wydawnictw, aktywnych w zakresie literatury informatycznej, wręcz uczy- niło z używania takich starych grafik swój znak rozpoznawczy.

W niektórych krajach dopuszczone jest, by autor mógł wcześniej deklarować od- danie dzieła do domeny publicznej. Często takie dzieła oznaczane są symbolem PD - „public domain”. W Polsce dzieła tego rodzaju de iure nie są w domenie publicz- nej jeśli nie jest spełniony podstawowy warunek upłynięcia odpowiedniego czasu od śmierci autora. Jest jednak mało prawdopodobne, by ktoś był ścigany i karany z powodu używania tego typu grafik.

Rysunki na wolnych licencjach Coraz częściej spotykamy się z rysunkami i zdjęciami na tak zwanych „wolnych licencjach”. Korzystają z nich nawet poważne wydawnictwa do tworzenia swoich publikacji, które to „dzieła zależne” są później wprowadzane do regularnej sprzedaży. Warto korzystać z tak rozpowszechnianych grafik ale trzeba pamiętać o warunkach, na których ich udostępnianie się odbywa.

Znane przykłady takich licencji tolicencje Creative Commons: CC-BY, CC-BY-NC, CC-BY-ND.

Należy sprawdzić zasady na jakich autor rysunek udostępnił i stosować się do jego wymagań. Zazwyczaj jest to podanie autora (-BY) i licencji, na jakiej dane dzieło jest udostępniane. Bardzo często jest też wymagane, aby nie modyfikować (-ND) oryginalnego dzieła, co oznacza na przykład, że nie można w nim „spolsz- czyć” napisów ani dorobić własnych elementów. Praca dyplomowa jest dziełem nie- komercyjnym (-NC), dlatego można w niej korzystać z rysunków o takim wymogu.

Rysunki zastrzeżone - użycie za zgodą Zdarza się, że z pewnych względów samodzielne wykonanie grafiki nie jest to możliwe. O ile rysunek można przeryso- wać „po swojemu” to znacznie trudniej otrzymać potrzebne zdjęcie. Nie każdy ma przecież dostęp do akceleratora w CERN, albo interferometrów LIGO i VIRGO, prawda? Wiele grafik jest chronionych „standardowo”, czyli przez „copyright”, co

czytamy jako „wszelkie prawa zastrzeżone”. Jednak często wystarczy jeden e-mail z prośbą o możliwość użycia rysunku w pracy dyplomowej aby autor odpisał krótko i pozytywnie: „OK, you may use it”. Nie jest to umowa ale lepsze tyle, niż nic - zachowujemy ten e-mail, najlepiej wydrukowany! Wówczas możemy obrazka użyć umieszczając w podpisie tekst w rodzaju: „© Jan Zagłoba, użyto za zgodą”. Czasem autor zdjęcia może mieć jakieś „specjalne życzenie” odnośnie użycia jego dzieła i na- leży to respektować (np.: zacytowanie jego artykułu).

Rysunki zastrzeżone - użycie bez zgody Bardzo, bardzo silnie odradzam uży- wanie grafik bez zgody ich autora. Niestety jest to powszechną praktyką. Jeśli nie mamy zgody autora to bezwzględnie należy podać źródło, skąd dana grafika została pobrana: „© Jan Zagłoba, Źródło: [13]”. Brak takiej informacji to plagiat. Z odpo- wiednim zaznaczeniem autorstwa będzie to „tylko” naruszenie czyichś praw au- torskich. Jeśli źródło było tej wagi, że może znaleźć się w bibliografii, to tam je umieszczamy a na końcu podpisu obrazka pojawia się standardowy odnośnik bi- bliograficzny. Jeśli źródło jest zbyt „słabe” by znaleźć się w bibliografii (np.: czyjś blog), to wówczas w przypisie dolnym umieszczamy wskazanie skąd zdjęcie pozy- skano (np.: adres URL). Jednak nie mając zgody na użycie grafiki (licencji) należy liczyć się z możliwością dochodzenia roszczeń przez autora. Zwyczajowo jako od- szkodowanie zasądzana jest trzykrotność ceny zdjęcia. A te są wyceniane bardzo różnie. Może to być „typowe” 100-200 złotych ale równie dobrze może to być kilka tysięcy…

Wykresy Wykresy rysowane w pakiecie biurowym - arkuszu kalkulacyjnym są zbyt słabej jakości by umieszczać je w pracy dyplomowej. Wykresy rysowane w płat- nym pakiecie Matlab, darmowym Scilab, czy otwartoźródłowym Octave będą lep- sze. Dla uzyskania jeszcze lepszych rezultatów można skorzystać z darmowego narzędzia jakim jestGnuplot. Dla programistów interesująca może być biblioteka matplotlib. Przy dużych zbiorach danych być może sensownie jest skorzystać zpro- jektu R. Niezależnie od wybranych narzędzi należy zawsze jednak pamiętać o tym, by forma nie stała się ważniejsza niż treść.

Spis treści

1 Wstęp 3

1.1 Dlaczego warto pisać pracę dyplomową? . . . 3

1.2 Zakres, autor i „własność” pracy dyplomowej . . . 4

1.3 Podstawy współpracy z promotorem . . . 5

1.4 Komunikacja z promotorem . . . 6

1.5 Wybór narzędzia do złożenia pracy . . . 7

2 Harmonogram 9 3 Osiągnięcia 12 4 Uwagi dotyczące tekstu pracy 13 4.1 Aspekty techniczne . . . 13

4.2 Treść . . . 14

4.3 Grafika . . . 18