niedziela, 22 stycznia 2012

Ogólne wymagania dla przygotowania pracy licencjakiej i/lub magisterskiej

Informacje podstawowe

Wykonanie pracy licencjackiej lub magisterskiej obejmuje wykonanie określonego przez promotora eksperymentu (programistycznego, zastosowania metody lub systemu, porównania metod lub systemów, projektowania, dowodzenia twierdzenia lub innego eksperymentu) oraz przygotowanie pracy w formacie i wymaganej liczbie egzemplarzy ustalonych przez władze stosownego Wydziału/Uczelni. Wymagane jest także dostarczenie -- oprócz wersji ,,papierowej'' -- dokumentu elektronicznego (szczegółowe wymagania są różne, czasami świadczą o małych kompetencjach w/z publikowania dokumentów elektronicznych ciała je stanowiącego).

Zaleca się umieszczenie na końcu pracy następującego oświadczenia: Ja, niżej podpisany(a) oświadczam, iż przedłożona praca dyplomowa została wykonana przeze mnie samodzielnie, nie narusza praw autorskich, interesów prawnych i materialnych innych osób. Oświadczenie należy oznaczyć datą i podpisem. Proszę się upewnić/zapytać w dziekanacie o dokładne brzmienie oświadczenia.

Praca licencjacka pisemna winna obejmować ok. 30--60 stron, a praca magisterska ok. 60--90 stron maszynopisu. Winna być przygotowana formacie LaTeX (preferowany przeze mnie), Open Office, MS Word (w ostateczności) lub innym programie (wg ustalenia z promotorem), tak aby oprócz formy drukowanej promotor mógł otrzymać wersję elektroniczną.

Uwaga: Nie ma ściśle ustalonego układu graficznego określającego marginesy, krój/stopień pisma, odstępy między śródtytułami. Dopuszczalna jest zatem pewna dowolność w tym zakresie, ale podstawowe zasady obowiązują i są one następujące: format strony A4, stopień pisma nie większy niż 12pt, jako podstawowy font dokumentu należy stosować jakiś krój szeryfowy (Times New Roman, Book Antiqua, itp.; Arial tylko do tytułów) odstęp między wierszami 1,5.

Układ pracy

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

  1. Strona tytułowa winna zawierać tytuł pracy, nazwisko i imię autora, promotora, rok i miejsce złożenia pracy).

  2. Spis treści.

  3. Wstęp zawierający: cel, motywację, metodologię pracy, układ pracy. Uwaga: nie należy we wstępie ,,rozpoczynać pracy'', np. umieszczać tu definicje, klasyfikacje itp.

  4. Część opisowa: opis wyników studium literaturowego dla tematu pracy (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 uzasadnienie eksperymentu planowanego w części doświadczalnej.

  5. Część doświadczalna: hipoteza badawcza, opis planowanego eksperymentu, metody, algorytmy, narzędzia, uzasadnienie wyboru (jeśli zaczerpnięte z szeroko rozumianej literatury, ze wskazaniem na część opisową, jeśli własne, oryginalne, szczegółowy opis), przebieg eksperymentu, wyniki eksperymentu.

  6. Dyskusja: ocena wiarygodności wyników, ich oryginalności, porównanie ze znanymi z literatury itp.

  7. 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).

  8. Literatura.

  9. Spis tabel i spis rysunków.

  10. Ewentualny wykaz skrótów i oznaczeń stosowanych w pracy.

  11. Ewentualne załączniki.

  12. Ewentualny skorowidz (skorowidze).

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

  1. Implementacja systemu lub programu komputerowego (hipotezą badawczą jest wtedy specyfikacja systemu, opis wyniku obejmuje m.in. instrukcję obsługi programu, przykłady użycia);

  2. Porównanie systemów komputerowych/metod programowania czy projektowania/algorytmów itp. (hipoteza badawcza: przewaga jednego nad drugim);

  3. Zastosowanie systemu komputerowego lub algorytmu do rozwiązania zadania praktycznego (hipoteza badawcza: system nadaje się do rozwiązania określonego zadania).

Spis literatury

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

Spis literatury należy przygotować w układzie alfabetycznym. Nie należy dzielić wykazu na kategorie, np. książki, artykuły, dokumenty internetowe. Pomijając wszystkie inne czynniki, wykaz literatury dla pracy mgr/lic jest tak krótki, że nie ma to większego sensu.

Pozycje literaturowe w spisie literatury można oznaczać: liczbą umieszczoną w nawiasie kwadratowym (zalecane), np. [3], umieszczonym w nawiasie okrągłym nazwiskiem autora i rokiem wydania, np.: (Cacacki, 1994) przy czym jeżeli w tym samym roku (pierwszy) autor ma więcej publikacji, to oznaczamy pozycje kolejno literkami, np. (Cacacki, 2000b).

Podając pozycję bibliograficzną należy podać: nazwisko autora, inicjał imienia, tytuł pracy, nazwę wydawcy, rok wydania. Jeżeli jest to czasopismo, należy podać dodatkowo: nazwę czasopisma, numer tomu, numery stron. Nie podaje się w tym przypadku nazwy wydawcy. Jeżeli jest to fragment książki (lub materiały z konferencji), to podajemy dodatkowo: tytuł książki, ew. nazwisko i inicjał redaktora oraz numery stron. Jeżeli jest to cytat z dokumentu dostępnego w Internecie, to podajemy dodatkowo adres WWW. Można nie podawać w tym przypadku nazwy wydawcy. Błędem jest umieszczenie wyłącznie adresu WWW w spisie literatury, bez określenia autora i tytułu dokumentu. Proszę się wzorować na poniższych przykładach:

Pozycje literatury cytuje się tak, jak się je oznacza, z tym, że pozycje oznaczone w spisie za pomocą liczby cytuje się w nawiasie kwadratowym, np. [13]. Jeżeli cytujemy wiele prac na raz odpowiednie numery należy umieścić w nawiasie kwadratowym i oddzielić przecinkami, np. [3,7,24]. W przypadku cytowania za pomocą nazwiska autora/roku postępujemy podobnie: (Cacacki 1980), (Cacacki 1992, Dadacki 1990).

Przykłady (Odpowiednio: książka, artykuł, fragment książki, dokument internetowy, praca zbiorowa typu encyklopedycznego):

[1] Knuth D. E., The TeXbook, Addison-Wesley 1986.

[2] Shave M. J. R., ,,Entities, functions and binary relations: steps to conceptual schema'', The Computer Journal 1981, 24/1.

[3] Jones M. L., ,,On the development of Data Models'', w: Edwards L. P. (red.), On the Conceptual Modelling, Berlin, Springer-Verlag 1984, s. 113--118.

[4] Pepper S., Whirlwind Guide to SGML Tools and Vendors, http://www.infotek.no/sgmltool/index.htm.

[22] Rocznik demograficzny 2000, GUS, Warszawa, 2001.

[24] Rocznik statystyczny Polski 2005, GUS, Warszawa, 2006.

Uwaga: numery pozycji niekoniecznie muszą być wewnątrz nawiasów kwadratowych -- może być bez nawiasów z kropką.

Jeżeli w pracy do cytowania wykorzystuje się schemat autor/rok, powyższy przykładowy spis winien wyglądać następująco:

Knuth D. E. (1986), The TeXbook, Addison-Wesley.

Shave M. J. R. (1981), ,,Entities, functions and binary relations: steps to conceptual schema'', The Computer Journal 24/1.

Jones M. L. (1984), ,,On the development of Data Models'', w: Edwards L. P. (red.), On the Conceptual Modelling, Berlin, Springer-Verlag, s. 113--118.

Pepper S., Whirlwind Guide to SGML Tools and Vendors, http://www.infotek.no/sgmltool/index.htm.

Rocznik demograficzny 2000 (2001), GUS, Warszawa.

Rocznik statystyczny Polski 2005 (2006), GUS, Warszawa.

Uwaga: Jeżeli do cytowania nie używamy numerów, nie należy ich umieszczać w spisie (bo w tym przypadku są tylko bezużytecznymi ozdobnikami).

Na podobnej zasadzie co prace zbiorowe typu encyklopedycznego (słowniki, roczniki statystyczne, encyklopedie) proponuję potraktować Wikipedię.

Machine learning, Wikipedia, http://en.wikipedia.org/wiki/Machine_learning.

Problem z wpisami z Wikipedii jest taki, że trudno ustalić datę ich wydania oraz autorów. Proponuję zatem pomijać datę wydania. Wpisy typu Wiki demonstrują też, że najmniej kłopotliwym system cytowania jest poprzez numer pracy ze spisu literatury.

Przygotowanie spisu literatury w systemie LaTeX można zautomatyzować wykorzystując program Bibtex. Użytkownicy OpenOffice mogą spróbować system bibus. Zaletą korzystania z programów do zarządzania jest możliwość korzystania z gotowej informacji bibliograficznej, udostępnionej on-line (np. jako usługa Scholar firmy Google).

Uwagi różne

Uwaga: porządek poniższych uwag jest dowolny; w szczególności nie odzwierciedla on ich istotności (ważne i mniej ważne są przemieszane).

Wszystkie rysunki i tabele w pracy muszą być numerowane i opatrzone tytułem/opisem. Zaleca się umieszczanie tytułu tabeli nad tabelą a opis rysunku pod rysunkiem. Tabele/rysunki muszą być opisane w tekście pracy; opis musi zawierać odsyłacz do tabeli/rysunku. Przykład opisu:

Szczegóły przedstawiono na rysunku 4, ...
Rys. 12 przedstawia rozszerzony model TAM

Albo

Model TTF (por. rys. 11) zawiera siedem następujących czynników...

Odsyłacze typu ,,tabela poniżej'', ,,powyższy rysunek'' są niedopuszczalne -- zawsze należy używać numeru.

Rysunki/tabele umieszcza się bezpośrednio w tekście, w miejscu pierwszego wzmiankowania. Jeżeli rysunek/tabela jest zbyt duży, może zostać przesunięty na początek następnej strony. Tabele mogą być dzieleone między strony, ale należy traktować to jako ostateczność (lepiej przesunąć tabelę na początek następnej strony niż podzielić między stronice--to jest powód, dla którego nie wolno używać odnośników powyżej/poniżej).

W przypadku rysunków/tabel należy określić ich autorstwo (źródło), podając je w podpisie rysunku lub tytule tabeli. Zamiast w podpisie można określić źródło w osobnym wierszu umieszczonym na dole tabeli/rysunku. Przykład (źródło w tytule tabeli):

Model TAM (źródło: [nr-pozycji-literaturowej])

Zamiast numeru oczywiście należy użyć innego schematu cytowania literatury, jeżeli takowy obowiązuje w pracy. Rysunki/tabele zaprojektowane samodzielnie oznaczamy frazą ,,opracowanie własne'', np.:

Model XTAM (źródło: opracowanie własne)

Nie używamy zwrotów Tabela nr. 99, rysunek nr. 5, tylko Tabela 99, rysunek 5.

Na końcu tytułów/śródtytułów, tytułów tabel i rysunków oraz pagin nie umieszcza się kropki.

Unikać eufemizmów/makaronizmów. Lista nielubianych/nadużywanych wyrazów zawiera m.in.: profesjonalny, biznesowy, elastyczny. Przykładowo profesjonalny (system, program), w znaczeniu będący na wysokim poziomie w danej dziedzinie zastąpić należy konkretem (lub konkretami). Podobnie w pozostałych przypadkach.

Unikać zwrotów: obecnie, wkrótce, powszechnie, itp... przy opisywaniu jakiegoś zjawiska. Należy (prawie) zawsze określać precyzyjnie co-gdzie-kiedy, oraz -- w miarę możliwości -- podać źródło danych.

Zaleca się wykorzystanie formy bezosobowej, np. przedstawiono, ustalono, omówiono, w czasie przeszłym. Nie należy mieszać stylów narracji, posługujemy się w całej pracy jednym najlepiej wykorzystującym formę bezosobową.

Nie używamy niepotrzebnie zaimków, w tym--a zwłaszcza, zaimków dzierżawczych (mój, twój, nasz, wasz, ich, jego, jej). Zamiast nasz system, nasz program lepiej często po prostu: system, program ewentualnie system X.

Podając definicje i klasyfikacje pojęć obowiązkowo wskazujemy źródło (chyba, że sami jesteśmy autorami). Przykłady:

Informacja to jest przyrost wiedzy, który może być uzyskany na podstawie danych (Tstchizris i Lochovsky 1965)...
Turski [34] definiuje Informatykę jako naukę o przetwarzaniu informacji zwłaszcza przy użyciu automatycznych środków pomocniczych...
Hurtownia danych to (por. Immon 1995): zbiór danych wspomagający podejmowanie decyzji, uporządkowany tematycznie, zintegrowany, zawierający wymiar czasowy oraz nieulotny.

Nie podaje się źródeł dla pojęć ,,oczywistych'', tj. ogólnie znanych: przykładowo nie podajemy źródeł definicji bitu, średniej arytmetycznej, itp.

Typowa praca składa się z 3--4 rozdziałów, podzielonych na punkty i ewentualnie podpunkty. Nie należy stosować bardziej szczegółowego podziału pracy. Tytuły wszystkich części pracy muszą być numerowane. Zwyczajowo natomiast Wstęp, Zakończenie, Spis LiteraturySkorowidz nie są numerowane.