Wskazówki formatowania pracy dyplomowej



W odpowiedzi na często zadawane pytania studentów postanowiłem nabazgrać, co następuje:



    1. Pisząc pracę dyplomową, należy zadbać o to, aby dobrze się ją czytało potencjalnemu czytelnikowi, a szczególnie recenzentowi. Co prawda ani Dekalog, ani dyrektywy Unii Europejskiej nie narzucają wyboru czcionki, można jednak założyć, że najczęściej stosowaną jest Times New Roman lub podobna, o rozmiarze 12 punktów. A skoro najczęściej stosowaną, to zapewne do takiej będą najbardziej przyzwyczajone oczy recenzenta... Co prawda odstępstwa od tej "normy" nie będą karane, ale można się np. spotkać z zarzutem chęci ukrycia niezbyt obszernej treści pracy (gdy czcionka jest za duża). Interlinię warto ustawić na 1,3 do 1,5. Tak się po prostu dobrze czyta.
    2. Za stroną tytułową umieszczamy spis treści, a za nim warto umieścić spis tabel i rysunków, oczywiście, jeśli takowe w pracy występują. Spisy rysunków, tabel itp. mogą także znaleźć się na końcu pracy.
    3. Należy unikać pisania tytułu podrozdziału tuż pod tytułem rozdziału wyższego poziomu. Wystarczy jedno-dwa zdania, nawet ogólnikowe, aby te tytuły rozdzielić. (wiem, że czasami bywa to trudne). Podobnie należy unikać umieszczania rysunków tuż pod tytułem rozdziału. Wtedy sprawa jest prostsza - wystarczy napisać np. "Schemat organizacyjny przedstawiono na rysunku..."
    4. Na każdej stronie należy umieścić nagłówek, zawierający tytuł rozdziału najwyższego poziomu (oraz numer strony, chociaż ten może też być w stopce). Po co? Ano po to, żeby ułatwić orientację w tekście osobie nie znającej pracy na pamięć, a szczególnie recenzentowi, który nie zawsze ma czas czytać recenzowaną pracę od deski do deski i będzie szukał w pracy tylko wybranych fragmentów. Nagłówek warto oddzielić od tekstu cienką linią, tak by nie zlewał się z tekstem, tylko stanowił odrębny wizualnie element strony.
    5. Należy konsekwentnie formatować akapity! Można zdecydować się na format polski (z wcięciem w pierwszej linii, bez odstępu od akapitów sąsiednich) lub anglosaski (bez wcięcia, z odstępem). Dobrze jest wyrównać tekst do obu marginesów i stosować dzielenie wyrazów.
    6. Należy zwrócić uwagę na przyimki (do, w, na, z, i, itp.), pozostające na końcu linii. Należy "przykleić" je do następnego wyrazu "twardą spacją". Aby zapobiec nierównym odstępom między wyrazami, warto włączyć dzielenie wyrazów. Nie wspomnę nawet o tak oczywistej sprawie, jak sprawdzanie pisowni - chociaż liczba literówek w pracach dyplomowych wskazuje, że mało kto o tym pamięta. Pomimo włączenia tej opcji, pracę przed wysłaniem należy na spokojnie przeczytać, najlepiej na wydruku, a jeszcze lepiej dać do czytania komuś z rodziny lub znajomemu. Z pewnością wychwycą oni błędy, których autor nie zauważył.
    7. Rysunki należy wykonywać własnoręcznie! Nie jest dobrze widziane wklejanie do pracy rysunków pobranych z internetu lub zeskanowanych z książek (pomijając już kwestie prawa autorskiego). Każdy rysunek powinien być zatytułowany, np.: "Rys. 1. Schemat organizacyjny". Tytuł umieszcza się pod rysunkiem. Do każdego rysunku w pracy powinno istnieć co najmniej jedno odwołanie w tekście, w przeciwnym razie nie jest pewne, czy ten rysunek w ogóle jest w pracy potrzebny. Należy odwoływać się przez numer rysunku, unikając określeń typu "powyżej/poniżej". Np.: "Schemat organizacyjny pokazano na rys. 1." Dzięki temu rysunek możemy umieścić w bardziej dogodnym miejscu pracy, np. na początku następnej strony, a jednocześnie nie traci on związku z tekstem. Absolutnie niedobrym rozwiązaniem jest umieszczenie rysunku bezpośrednio pod tytułem rozdziału, przed opisem. Jeśli już zupełnie brak pomysłu, można pod tytułem napisać coś w stylu: "Schemat organizacyjny pokazano na rys. 1" i dopiero pod tym - jakże wymownym - zdaniem zamieścić dalszy opis.
    8. Co się tyczy tabel, zasady są podobne jak dla rysunków. Jedyna różnica polega na tym, że tytuł tabeli umieszczamy NAD tabelą, a nie POD nią.
    9. Jeśli rysunek lub tabela pochodzą z jakiejś innej pracy (szczególnie innego autora), warto zasugerować, że nie jest to nasze dzieło. Można pod tabelą napisać np. "Źródło: A. Iksiński, Formatowanie pracy dyplomowej", ewentualnie "Źródło: [4]", pod warunkiem, że w spisie literatury pozycja [4] odpowiada A. Iksińskiemu. Moim zdaniem wystarczające jest zamieszczenie w tytule rysunku lub tabeli czegoś w stylu "[4]", ale prawnicy mogą mieć co do tego wątpliwości.
    10. Należy rozsądnie stosować źródła internetowe. Oczywiście nic nie stoi na przeszkodzie, by pobierać z internetu pliki z publikacjami naukowymi, dokumentacjami itp., szczególnie, gdy są to wersje elektroniczne dzieł, które i tak ukazały się w wersji drukowanej. Jednak nie należy przesadzać z odwołaniami do stron internetowych. Niektórzy mają nawet zastrzeżenia co do stosowania Wikipedii, choć moim zdaniem całkowity zakaz cytowania artykułów z Wikipedii jest przesadą. Można bowiem znaleźć tam artykuły wartościowe, opisujące zagadnienia, które trudno znaleźć gdzie indziej. Co więcej, dla każdego artykułu jest dostępna historia wersji, można więc zweryfikować, czy danego dnia można było przeczytać tam określony fragment informacji (tej zalety nie ma większość pozostałych źródeł internetowych).
    11. Na załączonej płycie (CD/DVD) powinny się znaleźć wszystkie pliki, wytworzone podczas realizacji pracy. Wskazane jest także załączenie pozostałych plików, które wykorzystywano podczas realizacji pracy. Rozważając załączenie pliku, dobrze odpowiedzieć sobie na pytanie: "co chciał(a)bym znaleźć na płycie, gdybym musiał(a) kontynuować pracę nad czyimś projektem?" W szczególności, na nośniku powinny się znaleźć:
      • pisemna część pracy, zarówno w postaci edytowalnej (np. DOC, DOCX, ODT, źródła w LaTeX-u), jak i w jednym z typowych formatów do publikowania tekstów (np. PDF, PS),
      • pliki źródłowe wytworzonego oprogramowania,
      • program w postaci wynikowej lub instalacyjnej,
      • schematy elektryczne oraz projekty płytek drukowanych (jeśli stanowią część pracy), zarówno w formacie używanym przez oprogramowanie do rysowania schematów, jak i w jednym z popularnych formatów graficznych (np. JPG, TIF, PCX, PNG itp.),
      • dokumentacje mniej typowych elementów elektronicznych (np. czujników, elementów wykonawczych),
      • oprogramowanie narzędziowe użyte do realizacji pracy, ALE TYLKO WTEDY, gdy taka dystrybucja nie narusza to niczyich praw (a więc nie załączamy pirackich wersji oprogramowania licencjonowanego, ale jeśli jest to freeware, shareware czy na licencji GPL, to można załączyć),
      • przykładowe pliki źródłowe użyte do testowania oprogramowania (jeśli były wykorzystywane podczas realizacji pracy),
      • przykładowe pliki wynikowe - jeśli są efektem działania programu.
      • na końcu pracy powinien znaleźć się krótki opis zawartości załączonego nośnika, np. "w katalogu xxx są pliki źródłowe, w yyy schematy, w zzz - wyniki pomiarów".
        Prezentowane poglądy reprezentują moje własne opinie i mogą pozostawać w sprzeczności ze wskazówkami innych promotorów. Mam jednak nadzieję, że tak czy inaczej przyczynią się do polepszenia jakości prac dyplomowych oraz zmniejszenia objętości moich odpowiedzi wysyłanych dyplomantom ;-)