Ramowe wymagania

Ramowe wymagania dla przygotowania pracy dyplomowej (licencjackiej i magisterskiej)

Opracowanie:
Mieczysław A. Kłopotek i Krzysztof Trojanowski

Założenia ogólne

Wykonanie pracy dyplomowej licencjackiej obejmuje wykonanie określonego przez promotora eksperymentu (programistycznego, zastosowania metody/systemu, porównania metod/systemów, projektowania, dowodzenia twierdzenia lub innego eksperymentu) oraz przygotowanie pracy pisemnej o ustalonym formacie i właściwie obłożonej w stosownej liczbie egzemplarzy.

Praca licencjacka pisemna winna obejmować ok. 30-60 stron maszynopisu.

Praca magisterska pisemna winna obejmować ok. 60-120 stron maszynopisu.

Limity te dotyczą wyłącznie tekstu pracy: od spisu treści do bibliografii – bez załączników.

Praca winna być przygotowana w Wordzie, Open Office, LaTeX’u lub innym systemie desktop-publishing (wg ustalenia z promotorem) i oprócz formy drukowanej promotor winien otrzymać wersję elektroniczną.

Podstawowym elementem pracy licencjackiej jest samodzielne wykonanie dużego projektu programistycznego, natomiast praca magisterska winna się charakteryzować ponadto oryginalnym wkładem własnym do rozwiązania zagadnienia teoretycznego rozpatrywanego w pracy.

Układ ramowy pracy

Praca pisemna winna mieć następujący układ ramowy:

  1. Strona tytułowa i oświadczenie studenta, że praca została wykonana samodzielnie(ściśle wg wzoru UKSW).
  2. Spis treści.
  3. Ewentualny wykaz skrótów i oznaczeń stosowanych w pracy.
  4. Wstęp: cel, motywacja, metodologia pracy, układ pracy.
  5. Część opisowa (opis wyników studium literaturowego relewantnych dla tematu pracy):
    • sprecyzowanie dziedziny (np. problemu optymalizacyjnego, konstrukcja klasyfikatora, budowa sterownika, etc), na której będą odbywały się eksperymenty,
    • metody, algorytmy, systemy itp. wykorzystane w części eksperymentalnej, metody, algorytmy i systemy im pokrewne bądź alternatywne, ze wskazaniem ich wad, zalet, dziedzin zastosowań i ograniczeń.

    W podsumowaniu części opisowej – uzasadnienie eksperymentu planowanego w części doświadczalnej.

  6. Część doświadczalna:
    • hipoteza badawcza,
    • szczegółowy opis metod, algorytmu, oraz ewentualnych innych narzędzi zaimplementowanych w pracy (dane wejściowe i wynikowe, precyzyjny opis działania zawierający pseudokody lub schematy blokowe, lista parametrów sterujących, wyniki testów obciążeniowych) uzasadnienie wyboru (jeśli zaczerpnięte z szeroko rozumianej literatury, to ze wskazaniem na część opisową, natomiast jeśli własne, oryginalne, to szczegółowy opis),
    • miary zastosowane przy zbieraniu wyników,
    • opis planowanego eksperymentu: lista zadań testowych, lista wartości dla wszystkich parametrów sterujących – tych, których wartości zostały ustalone i tych, których wartości podlegały zmianom,
    • przebieg eksperymentu,
    • wyniki eksperymentu.
  7. Dyskusja: ocena wiarygodności wyników, ich oryginalności, porównanie ze znanymi z literatury itp.
  8. Podsumowanie/wnioski: najważniejsze osiągnięcia pracy, wynikające wnioski dla ewentualnych dalszych badań (Podsumowanie winno opierać się w całości na materiale zawartym w pracy).
  9. Literatura.
  10. Ewentualny indeks rzeczowy.
  11. Ewentualne załączniki.

Termin “eksperyment” należy rozumieć szeroko, stosownie do tematu pracy. Przykładowo eksperymentem może być:

  • implementacja systemu/programu komputerowego (hipotezą badawczą jest wtedy specyfikacja systemu, opis wyniku obejmuje m.in. instrukcję obsługi programu, przykłady użycia)
  • porównanie systemów komputerowych/metod programowania czy projektowania/algorytmów itp. (hipoteza badawcza: przewaga jednego nad drugim)
  • zastosowanie systemu komputerowego/metody/algorytmu do rozwiązania zadania praktycznego (hipoteza badawcza: system nadaje się do rozwiązania określonego zadania)

Szablon pracy dyplomowej

Przykładowy układ ramowy pracy – szablon pracy dyplomowej wraz z informacjami, co powinno się znaleźć w poszczególnych rozdziałach pracy, jest do obejrzenia tutaj: Praca dyplomowa

Źródło latex’owe szablonu (do wykorzystania przy pisaniu pracy):
praca-dyplomowa-szablon
Klauzula zgody: wyrażam zgodę na nieodpłatne wykorzystanie powyższego szablonu latex’owego przez studentów UKSW w celu napisania pracy dyplomowej na UKSW.

Wymagania formalne dotyczące tekstu pracy

Poniżej znajdują się wymagania formalne dotyczące stałych elementów tekstów wszystkich prac
dyplomowych. Wymagania te dotyczą:

  1. literatury,
  2. sposobów cytowania literatury,
  3. prezentacji tabel i rysunków,
  4. zamieszczania i korzystania z wzorów i symboli,
  5. załączników do pracy.

Literatura

W spisie literatury należy umieszczać tylko te pozycje, które są cytowane w pracy.

Spis literatury należy przygotować w układzie alfabetycznym.

Kolejne elementy pojedynczej pozycji bibliograficznej:

  1. Nazwiska autora(ów) pisane w kolejności: najpierw nazwisko, potem inicjały imion.
  2. Dwukropek, który rozdziela informacje o autorach od tytułu pracy.
  3. Tytuł pracy: kursywą, jeżeli jest to tytuł książki, lub standardową czcionką w pozostałych przypadkach.
  4. Po tytule kropka.
  5. Informacje na temat wydawnictwa:
    • dla artykułów w czasopiśmie: nazwa czasopisma (kursywą), rok wydania i w nawiasie numer woluminu
      ewentualnie za nawiasem numer zeszytu, numery stron od .. do .. ,
    • dla książek: nazwa wydawnictwa, miejsce wydania, rok wydania, numery stron od .. do .. ,
    • dla artykułu w wydawnictwie konferencyjnym: nazwiska i inicjały edytorów, tytuł woluminu zakończony kropką,
      nazwa wydawnictwa, miejsce i rok wydania, numery stron od .. do .. ,
    • dla materiałów ze strony www: tytuł materiału, adres strony www, data ostatniej aktualizacji
      lub data odwiedzin przez studenta.
  6. Kropka.

Pozycje literaturowe w spisie literatury można przy tym oznaczać:

  • kolejną liczbą umieszczoną w nawiasie kwadratowym np. [3]
  • liczbą z kropką np. 3.
  • umieszczonym w nawiasie kwadratowym lub okrągłym nazwiskiem autora i rokiem wydania, np.:
    [Quinlan, 1996],
    (Quinlan, 1996),
    [Wang, Witten, 1997],
    [Breiman i inni, 1984],
    przy czym jeżeli w tym samym roku (pierwszy) autor ma więcej publikacji, to oznaczamy pozycje kolejno literkami, np. [Quinlan, 1996b],
  • umieszczonym w nawiasie kwadratowym kodem z trzech pierwszych liter nazwiska (pierwszego) autora i dwucyfrowego roku wydania, np.: [QUI96],
    przy czym jeżeli powstanie niejednoznaczność kodu, bo mamy więcej cytowanych publikacji tego autora z tego samego roku, to oznaczamy pozycje kolejno literkami, np. [QUI96b].

Przykład:
[1] Quinlan J.R.: Improved use of continuous attributes in C4.5. Journal of Artificial Intelligence Research 1996 (4), str. 77-90.
[2] Quinlan J.R.: C4.5: Programs for Machine Learning. Morgan Kaufmann, San Mateo, CA, 1993.
[3] Quinlan J.R.: Learning with continuous classes. Adams N. and Sterling L. Eds., Proceedings of the 5th Australian Joint Conference on Artificial Intelligence. World Scientific, Singapore 1992, str. 343-348.
[4] Frank, E., Wang, Y., Inglis, S., Holmes, G. Witten, I. H.: Using model trees for classification. http://www.cs.waikato.ac.nz/~ml/publications/1998/Frank-et-al-Model-Trees.pdf, data ostatniej modyfikacji 12.12.1999

Cytowanie literatury

Pozycje literaturowe cytuje się tak, jak się je oznacza, z tym, że pozycje oznaczone w spisie przez cyfrę z kropką cytuje się w nawiasie kwadratowym np [3]. Jeżeli chcemy zacytować grupę prac, to możemy to zrobić w jednym nawiasie kwadratowym, np. [3,7,24].

Jeżeli student zamieszcza w pracy cudzy rysunek, powinien bezwzględnie w podpisie pod rysunkiem podać źródło, a niezależnie od tego sprawdzić, czy kopiowanie rysunku jest dozwolone przez jego autora, a jeśli autor stawia warunki, student musi te warunki spełnić (np. poprosić o pisemna zgodę).

Jeśli student dosłownie przytacza tekst z cudzego artykułu, musi ująć go w cudzysłów, a za tekstem podać odnośnik literaturowy. Jeśli cytat jest z książki, dodatkowo trzeba podać numer strony.

Dosłowne przytaczanie cudzych stwierdzeń winno się ograniczyć do niezbędnego minimum, zdroworozsądkowym limitem ilości cytowanego tekstu jest 10 linijek łącznie. Generalnie należy raczej starać się wyrazić zawartą w cytowanym tekście informację swoimi słowami. Nawet jednak, gdy treści wzięte z literatury opisywane są własnymi słowami, należy podać odnośnik do odpowiedniej pozycji w załączonym spisie literatury. W przypadku większych tekstów bazujących na jednej pozycji bibliograficznej należy na początku zapowiedzieć, iż np. informacje podane w poniższym akapicie lub podrozdziale w całości pochodzą z pozycji bibliograficznej [xx]. Każde stwierdzenie nie poparte pozycją bibliograficzną jest traktowane jako własne uzyskane w trakcie badań i konieczne jest dla niego uzasadnienie poprzez przedstawienie przez studenta własnych potwierdzających je wyników.

Tabele i rysunki

Wszystkie tabele i wszystkie rysunki muszą być ponumerowane i podpisane.

Na rysunkach należy zaznaczyć, jakie pojęcia (czas, prędkość, częstotliwość,..) reprezentują poszczególne osie współrzędnych. Należy też zaznaczyć, co reprezentuje wykres serii danych. W przypadku prezentacji kilku serii danych na jednym rysunku, muszą się one wyraźnie różnić krojami linii, lub kolorami. Informacje te należy podać na wszystkich rysunkach, nawet jeżeli w pracy występują całe grupy rysunków dotyczące tych samych pojęć oraz wartości pomiarowych.

Na każdy rysunek i na każdą tabelę należy się powołać w tekście wyjaśniając, w jaki sposób uzyskano wyniki tam zawarte i jak je interpretować.

Pseudokod i schematy blokowe traktujemy dokładnie w taki sam sposób jak rysunki.

Wzory i skróty

Wszystkie wzory, na które się powołujemy powinny być numerowane. Numery wzorów ujmujemy w nawiasy okrągłe zarówno przy numerowaniu, jak i przy powoływaniu się na nie.

Wszystkie symbole użyte we wzorach powinny być objaśnione przed pierwszym wystąpieniem tego wzoru w tekście, lub bezpośrednio za wzorem.

Każde pojęcie wykorzystane w pracy powinno być we wszystkich wzorach jednolicie oznaczone tym samym symbolem. Różne pojęcia powinny być oznaczone różnymi symbolami.

Jeżeli autor używa więcej niż 10 symboli w swojej pracy, na początku pracy (po spisie treści, ale przed wstępem) powinien umieścić wykaz stosowanych oznaczeń i symboli.

Każdy skrót należy zawsze objaśnić bezpośrednio po jego pierwszym użyciu w tekście.

Załączniki do pracy

Do pracy należy załączyć CD zawierający:

  1. tekst źródłowy pracy (plik w formacie MSWord, OpenOffice, LaTeX (z dołączonymi rysunkami),
  2. kod źródłowy programu,
  3. kod wykonawczy programu,
  4. szczegółowa instrukcja kompilacji i instalacji programu,
  5. instrukcja użytkowania programu,
  6. szczegółowe wyniki wszystkich eksperymentów, na które autor powoływał się w swojej pracy.

Ramy czasowe – czarny scenariusz dla studenta

Ponieważ pracę trzeba złożyć do początku czerwca, więc student powinien:

W semestrze zimowym:

  1. do końca października zgłosić się po wytyczne literaturowe oraz ogólny zakres pracy (w tym implementacji). Należy się liczyć z tym, że większość, jeżeli nie całość literatury, będzie napisana w języku angielskim,
  2. do połowy stycznia winien przedłożyć pisemne opracowanie z badań literaturowych ze wskazaniem materiałów do bezpośredniego wykorzystania w implementacji,
  3. do końca semestru zimowego powinien powstać prototyp aplikacji, który wraz z opracowaniem pisemnym stanowi podstawę do zaliczenia semestru
  4. do początku semestru letniego winien uzgodnić szczegółową koncepcję rozbudowy implementacji i szczegółowy plan badań.

W semestrze letnim:

  1. do połowy kwietnia zakończyć prace implementacyjne,
  2. do końca kwietnia zakończyć eksperymenty,
  3. od tego momentu cały swój czas poświęcać na pisanie pracy dyplomowej,
  4. w ostatnim tygodniu maja przedłożyć promotorowi do przejrzenia ostateczną wersję pracy – spełniającą wyżej wspomniane wymogi formalne (układ ramowy i wymagania formalne), tak by można się było skupić na jej MERYTORYCZNYM dopracowaniu w ramach intensywnych konsultacji z promotorem.

Powyższe terminy są NAJPÓŹNIEJSZE z możliwych.

Polecam do przeczytania przed przystąpieniem do pracy

Notes on Doing a Project – podobne wskazówki do tych powyżej, ale adresowane do studentów Department of Computer Science, University of York, UK (warto porównać choćby po to, żeby sprawdzić, czy nie przesadziłem z wymaganiami)

Efficient Reading of Papers in Science and Technology – this brochure provides an approach to help you read scientific papers efficiently and effectively.