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)3, 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ó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 LATEX. 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 prawa4. 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.