Jak pisać prace dyplomowe - uwagi o formie

Struktura i zawartość pracy

• Struktura pracy może być następująca:
  - Formularz pracy z podpisem Dziekana.
  - Strona tytułowa.
  - Spis treści.
  - Wstęp zawierający podrozdział "cel i zakres pracy", ten podrozdział zawiera streszczenie specyfikacji wymagań promotora :-)
  - Rozdział(y) "teoretyczny" definiujący(e) rozważane zagadnienie i opisujący aktualny stan wiedzy. Więcej o tym rozdziale.
  - Rozdział(y) "projekt" opisujący(e) na wysokim poziomie abstrakcji sposób rozwiązania postawionego problemu. Więcej o tym rozdziale.
  - Rozdział(y) "implementacja" opisujący(e) przebieg implementacji, użyte narzędzia, przeprowadzone testy, oraz innego rodzaju uzyskane wyniki. Więcej ...
  - Rozdział(y) "analiza wyników" opisujący(e) przeprowadzone badania oraz analizujący uzyskane wyniki. Więcej ...
  - Rozdział(y) "podręcznik użytkownika" opisujący(e) jak należy używać wytworzonego oprogramowania (produktu). Więcej ...
  - Zakończenie - zawierające posumowanie, wnioski.
  - Literatura.
  - Dodatki.
  
• Zamieszczanie list tabel, list rysunków, list wykresów nie ma sensu.
• Pisząc pracę proszę zwrócić uwagę na rozkład liczby stron między rozdziałami. Wkład pracy dyplomanta powinien mieć odzwierciedlenie w rozmiarach poszczególnych rozdziałów. Dlatego, np. rozdział opisujący aktualny stan wiedzy nie powinien być nieproporcjonalnie dłuższy niż np. rozdział opisujący implementację, czy testy.
• Całkowita liczba stron pracy nie ma istotnego znaczenia. Działania prowadzące do sztucznego jej zwiększenia są podejrzane. Istotna jest treść pracy. Dlatego proszę:
  • nie zwężać obszaru tekstu w miarę zagłębiania się w strukturze rozdziałów, sekcji, akapitów, list, pod-list itp.;
  • nie wolno manipulować odstępem między literami w wyrazach, ani między wyrazami w zdaniach!
  • proszę używać czcionki 10-12 pt, preferowany jest Times New Roman dla zwykłego tekstu i Courier New dla kodu programu
  • interlinia 1.5 jest preferowana, proszę nie stosować interlinii większej niż 2,
  • Znaki interpunkcyjne : . , ; ! ? ) } ] itp. należy dosuwać w lewo, tak aby nie było przed nimi spacji (w przeciwnym razie można oczekiwać linijek zaczynających się od znaku interpunkcyjnego), znaki otwierające nawiasy ( { [ i cytowania " ' powinny być dosunięte w prawo;
  • proszę wyrównywać tekst do lewego i prawego marginesu (tzw.justowanie).
• Proszę unikać odnośników w stopce strony. Wszelkie uwagi, komentarze, wtrącenia należy zawrzeć w głównym tekście.
• Strony pracy muszą być ponumerowane (z wyjątkiem strony tytułowej :-)
• W spisie treści nie ma sensu zamieszczać informacji o częściach pracy położonych poniżej 3. poziomu zagłębienia. Np. numer sekcji 4.3 lub 4.3.1 jest akceptowalny, ale numer 4.3.2.1 lub 5.4.3.2.1 nie jest.
• Każdy rozdział powinien zaczynać się od nowej strony (rozdział to część pracy na najwyższym poziomie struktury pracy).
• Sierotki i wdowy. Jeżeli tytuł rozdziału znajduje się w ostatniej linii na stronie a cała reszta rozdziału na następnej, lub gdy tekst kończy się jedną linią na nowej stronie, to są to właśnie tzw. sierotki i wdowy. Takie sierotki i wdowy są nieeleganckie. Trzeba ich unikać. Nota bene, LaTeX sam radzi sobie z nimi dość dobrze.
• Proszę unikać podziału elementu struktury pracy (np. rozdziału) na jedną część składową (np. pod-rozdział). Np. rozdział 1.2 zawierający podrozdział 1.2.1, i nic więcej, jest nieelegancki. W takim przypadku proponuję nie wydzielać części składowej (podrozdziału).
• Nagłówki i stopki. Jeżeli ktoś koniecznie chce mieć nagłówki i stopki w swojej pracy, to proszę na wzór wziąć sobie porządnie wydaną książką naukową lub techniczną. W szczególności strona tytułowa pracy, ani strony tytułowe części pracy na poziomie rozdziału (a więc także spis treści) nie powinny mieć nagłówków. Nagłówek powinien zawierać tytuł rozdziału. Poprawnie robi to LaTeX w stylu book. Jeżeli użycie takiego stylu jest zbyt kłopotliwe, to proszę sobie darować ozdobniki w postaci nagłówków i stopek stron. Proszę jednak nie zapominać o numerach stron.
• Współcześnie w pracy nie drukuje się już całego kodu źródłowego programów. Kod źródłowy napisanych programów, wszelkie oprogramowanie wytworzone i wykorzystane (*) w pracy, wyniki przeprowadzonych eksperymentów (logi, pliki arkuszy kalkulacyjnych) powinny zostać umieszczone na nośniku (CD,DVD) stanowiącym dodatek do pracy, tak aby możliwe było uruchomienie programu, kompilacja kodu, odtworzenie uzyskanych wyników.
  (*) O ile nie narusza to praw autorskich innych osób, firm itp.
• Mile widziane jest umieszczenie tekstu pracy na nośniku elektronicznym oraz adresu kontaktowego (numer telefonu, email). Ma to na celu ułatwienie korzystania z wyników pracy kolejnym studentom.

Formuły matematyczne, wzory

• Formuły matematyczne zapisuje się w matematycznym stylu, poprawnie robi to TeX/LaTeX oraz MSEquationEditor. W skrócie, należy:
  • zapisywać formuły kursywą, z wyjątkami:
  • cyfry, znaki: (), [], {}, <, >, <=, >=, =, <>, +, -, :, |, nazwy powszechnie używanych funkcji (np. log, sin, max, min) zapisujemy normalną czcionką.
• Elementy formuł matematycznych takie jak oznaczenia zmiennych, parametrów itp. pojawiające się w tekście również powinny zostać zapisane w matematycznym stylu, tak jak to opisano powyżej.

Kod źródłowy, pliki tekstowe.

• Zawartość różnych plików tekstowych, np. kodów źródłowych lub plików z danymi proszę umieszczać jako tekst z ciemnymi literami na białym tle, a nie jako mapę bitową (grafikę). Białe(jasne) napisy na czarnym tle są nieczytelne po wydruku. Bitmapowe grafiki się nie skalują i umieszczony w taki sposób wycinek kodu wygląda bardzo źle i zupełnie inaczej niż pozostały (zwykły) tekst. Teksty kodów źródłowych z kolorowaniem składni można przeciągać przez notepad++ i kopiować z notepad++ do Worda z zachowaniem formatowania i kolorowania składni. Dla LaTeXa istnieją pakiety kolorujące składnię np. minted.

Rysunki i tabele

• Wszystkie rysunki, tabele, wykresy powinny być podpisane i ponumerowane w celu umożliwienia odwoływania się do nich.
• Podpis rysunku, przy którym jest jego numer, powinien być składnikiem tekstu pracy, a nie rysunku (grafiki). Natomiast opisy wewnętrznych elementów rysunku, takich jak oznaczenia osi, liczby przy osiach, itp. powinny być elementem rysunku (grafiki).
• Rysunki i wykresy muszą być czytelne. Dlatego:
  • mapy bitowe powinny mieć odpowiednią rozdzielczość (300DPI lub lepszą), bo to co dobrze wygląda na ekranie nie musi dobrze wyglądać na wydruku. Najlepiej jednak używać grafiki wektorowej.
  • tło i elementy rysunku powinno być kontrastowe, najlepiej aby tło było białe, a linie i inne elementy rysunku czarne (lub w innych wyraźnych, kontrastowych kolorach).
• Uważam, że wykresy są bardziej czytelne i nie ma sensu umieszczać w tekście pracy tabel z danymi liczbowymi użytymi do ich sporządzenia. Dane liczbowe do sporządzenia wykresów należy zawrzeć w tabelach w dodatku na końcu pracy lub na nośniku elektronicznym (CD,DVD). Jeżeli taki dodatek miałby długość większą niż ok.8 stron, to tabele proszę pozostawić tylko na nośniku elektronicznym.
• Na osiach liczbowych wykresów nie powinny występować znaczniki dla wartości, które nie mają realnego sensu, np. realnego sensu nie mają ułamkowe wartości w odniesieniu do obiektów dyskretnych (policzalnych), np.: 3.5 zadania, 0.1 bajta, 0.25 dysku.
• Wykresy i tabele powinny być umieszczone możliwie najbliżej miejsc, w których są opisywane. Jeżeli jednak miałaby to być tabela, której rozmiary są bardzo duże (wiele stron), to lepiej zrobić na jej podstawie wykres, a ją samą przenieść do dodatków lub na nośnik elektroniczny.
• Wygładzanie linii na wykresach najczęściej nie ma sensu, gdyż prezentowane wyniki najczęściej dotyczą jedynie dyskretnego zbioru punktów pomiarowych (na osi X) i nie wiemy co jest pomiędzy nimi. Lepiej użyć łamanych (odcinków), aby prowadziły oko od punktu do punktu.

Referencje do literatury

• Praca musi zawierać "Literaturę" (lub inaczej piśmiennictwo, referencje). Lista "literatura" powinna być oddzielną częścią pracy, na poziomie rozdziału w strukturze pracy. Każda pozycja w spisie literatury musi zawierać: autora, tytuł pracy, wydawnictwo/czasopismo/adres http/ftp, rok publikacji, strony od-do w przypadku artykułów w czasopismach. Lista nie może zawierać pozycji, do których nie ma odwołań w tekście. Lista powinna być posortowana alfabetycznie według nazwisk autorów. Pozycje na liście referencji powinny być ponumerowane kolejnymi liczbami naturalnymi. Używanie skrótów nazwisk autorów lub ich inicjałów w połączeniu z rokiem wydania, np. AB99, jest także akceptowalne.
• Praca musi zawierać odwołania w tekście do wszystkich pozycji w literaturze. Preferowana forma odwołań to numer pozycji w spisie zamknięty w nawiasach kwadratowych, np. [1], [23]. Odwołania [AB99] są także akceptowalne, jednak wówczas lista pozycji literaturowych musi zawierać te skróty, a nie kolejne numery pozycji. Proszę nie umieszczać odwołań do literatury w stopce strony. Odwołania do numeru strony i linijki, w której coś powiedziano w jakimś artykule/książce nie jest pożądane (bo często wyrywa to stwierdzenia z kontekstu). Taki jest też styl odwołań w literaturze technicznej i nauk ścisłych (matematyki, informatyki), że nie podaje się zdań wyjętych z kontekstu jakiejś publikacji.
• Odwołania do literatury ([1],[123], [AB99]) nie powinny występować w tytułach rozdziałów.
• Odwołanie do literatury ([1],[123], [AB99]) traktuje się jak słowo, dlatego powinno mieć przed sobą i za sobą spację (z wyjątkiem dosuniętych za nim znaków interpunkcyjnych). W razie wątpliwości proszę wziąć sobie za wzór jakąś porządną książkę techniczną, matematyczną, lub informatyczną.
• Odwołania do źródeł internetowych należy umieszczać razem z innymi źródłami. Nie ma potrzeby tworzenia dla nich oddzielnej listy.
• W razie trudności znalezienia autora źródła internetowego, można użyć nazwy firmy (np. Amazon, Intel, Microsoft, Mozilla) lub instytucji (Apache), które wytworzyły dany dokument.

Styl wypowiedzi

• Proszę nie silić się na "elegancki" styl, gdyż najczęściej wychodzi styl bombastyczny :-)
  Np.: "jeden z najznamienitszych przykładów", "program niesamowicie prosty w obsłudze", "proces jest niezwykle trywialny", "celem znakomitej większości".
• Przeciwieństwem powyższego stylu "eleganckiego" jest styl "zdawkowo-technokratyczny". Objawia się on np. zdawkowymi sformułowaniami, np. w postaci równoważników zdań, zawieszonymi w próżni zbiorami list wypunktowujących różne zagadnienia, paragrafami (akapitami) bez wzajemnego związku. Praca powinna dać się normalnie czytać tak jak esej lub wypracowanie.
• Poszczególne części pracy i wypowiedzi powinny z siebie logicznie wynikać. Powinny być zapowiedziane i przewidywalne. Dobrze jest przechodzić od "ogółu do szczegółu". Dzięki temu wypowiedzi logicznie wynikają z siebie, są zapowiedziane i przewidywalne.
• Pisząc pracę z informatyki, proszę używać terminologii informatycznej, która ma sprecyzowaną treść i znaczenie. Proszę nie używać gazetowych określeń typu: silnik programu, maszyna skryptowa, elektroniczny mechanizm, gdyż nie wiadomo co one właściwie oznaczają.
• Proszę unikać fantazyjnej formy np. tytułów rozdziałów pisanych specjalną czcionką, itp. Proszę skupić się na treści pracy.
• Tytuły rozdziałów proszę kończyć kropką tylko gdy są zdaniami, tj. zawierają orzeczenie i podmiot.
• "Ilość" i "liczba." Proszę zauważyć, że liczba dotyczy rzeczy policzalnych np. liczba osób, zadań, procesorów. Ilość dotyczy rzeczy niepoliczalnych, podzielnych w sposób ciągły np. ilość wody, energii itp. Chociaż współczesne normy języka polskiego dopuszczają zamienne użycie "ilość" i "liczba", to proszę starać się wyrażać precyzyjnie, tj. zgodnie z naturą obiektów.
• "Ja", "my", czy forma bezosobowa? Aby uniknąć posądzenia o nieskromność autora, zamiast I osoby liczby pojedynczej ((ja) zrobiłem, (ja) zaprojektowałem, (ja) zaprogramowałem, (ja) przetestowałem) przyjęło się używać formy bezosobowej (zrobiono, zaprojektowano, zaprogramowano, przetestowano) lub I osoby liczby mnogiej (zrobiliśmy, zaprojektowaliśmy, zaprogramowaliśmy, przetestowaliśmy). Moim zdaniem najodpowiedniejsza jest forma bezosobowa.
• Spolszczenia. Używanie słów z obcych języków może sprawiać trudność. Zauważyłem trzy podejścia do kwestii spolszczeń:
  • używanie obcych słów bez żadnych spolszczeń (np. "słucham radio", "projekt interface użytkownika", "używam Hibernate", "tej funkcji brakuje w tym framework", "w Cocoon istnieją potoki", "te dane zapisałem w XML");
  • używanie obcych rdzeni słów z polską końcówką oddzieloną apostrofem lub kreseczką (np. "słucham radio-a", "projekt interface-u użytkownika", "używam Hibernate'a", "tej funkcji brakuje w tym framework'u", "w Cocoon-ie istnieją potoki", "te dane zapisałem w XML'u");
  • konsekwentne spolszczanie (np. "słucham radia", "projekt interfejsu użytkownika", "używam Hibernejta", "tej funkcji brakuje w tym frejmworku", "w Cocoonie istnieją potoki", "te dane zapisałem w XMLu").
  Wszystkie te sposoby mogą razić. Chyba najgorsze jest wyjście drugie polegające na użyciu "podpórek" w postaci apostrofów lub kreseczek (chociaż właśnie taka jest polska norma, aby po samogłoskach dodać apostrof i polską końcówkę). Jak pokazują przykłady słów "radio" i (chyba już także) "interfejs", trzymanie się wersji oryginalnej, na dłuższą metę, nie jest możliwe. Sensowne wydaje się więc konsekwentne spolszczanie. Niestety, dopóki nie ustali się jakaś powszechnie używana norma jesteśmy skazani na nie zawsze udane próby spolszczania. Podsumowując, ja osobiście głosuję za trzecim wyjściem (spolszczanie).
• Kalki z angielskiego.
• Proszę nie oczekiwać, że ja za Państwa wykonam najprostszą pracę korektorską. Błędy ortograficzne dość skutecznie można wyeliminować automatycznymi narzędziami. Tylko trzeba ich używać.
• Proszę nie pisać pracy metodą "cut & paste", bo to jest plagiat i dowód intelektualnej indolencji autora. Dane zagadnienie można opisać własnymi słowami. Zawsze trzeba powołać się na zewnętrzne źródła.
• Proszę unikać długich zdań.

LaTeX

Pisanie prac w LaTeXu uważam za dobry pomysł. Wiele spraw związanych z formatowaniem, strukturą pracy, referencjami oraz zapisem wzorów matematycznych bierze na siebie środowisko LaTeXa.
Do celów redakcyjnych (czyli do sprawdzania pracy) wygodniej mieć tekst wydrukowany z podwójną interlinią (można użyć \baselinestretch \baselineskip). Osobom zainteresowanym pisaniem pracy w LaTeXu polecam stronę Cezarego Sobańca, lub szablon przygotowany przez Martę Szachniuk na podstawie wcześniejszego szbalonu Dawida Weissa.

Szablon dla MSWord, opracowany przez Pana Bartosza Wawrzyniaka w 2020r. na podstawie szablonu LaTeXowego Marty Szachniuk.

Uwagi o prawach autorskich do prac dyplomowych na PP

Maciej Drozdowski