Treść i styl

Na treść pracy składa się tekst oraz struktura tego tekstu. Nawet dobry tekst pozbawiony właściwej struktury będzie oceniony źle. Dobra i czytelna struktura pracy pozwala łatwiej przyswoić nawet trudny i lakoniczny przekaz.

W pracach inżynierskich i magisterskich powinien być stosowany styl naukowy. Oznacza to przede wszystkim konieczność zachowania chłodnego obiektywizmu. By to osiągnąć warto ciągle mieć na uwadze dwa fundamentalne pojęcia:

• związek przyczynowo-skutkowy,
• chronologia.

Pisząc pracę należy wybrać i trzymać się jednego z dwóch podejść: “od ogółu do szczegółu” albo “od szczegółu do ogółu” (ang. “top-down” albo “bottom-up”). Każdy z tych stylów omawiania problemu może być równie przystępny dla czytelnika.

W pracach inżynierskich wnioski są formułowane na podstawie doświadczeń empirycznych, które mogą obejmować wykonanie jakiegoś urządzenia lub oprogramowania.

Prace magisterskie muszą stać pod tym względem nieco wyżej i oprócz języka naukowego powinny stosować również metodę naukową czyli formułowania hipotez i wyciągania wniosków na podstawie obserwowalnych faktów. “Wątek naukowy” pracy magisterskiej jest elementem poddawanym szczególnemu recenzowaniu i podlega ocenie komisji egzaminującej. Niedopuszczalne jest wybiórcze traktowanie wyników i dopasowywanie faktów do głoszonych teorii.

Tekst pracy dyplomowej stanowią zdania a nie równoważniki zdań lub rzucane hasła. Pozbawienie zdania orzeczenia nie czyni go stwierdzeniem naukowym.

Zamiast:

AES. Współczesny, uznawany za bezpieczny, algorytm szyfrowania.

lepiej:

AES to współczesny, uznawany za bezpieczny, algorytm szyfrowania.

i jeszcze lepiej:

AES jest współczesnym algorytm szyfrowania. W ocenie ekspertów jest on uznawany za bezpieczny.

Szczególnie często ten błąd pojawia się w przypadku rozbudowanego tekstu towarzyszącego liście wypunktowanej oraz tuż za tytułami rozdziałów i podrozdziałów. Nie można traktować tytułu rozdziału lub podrozdziału jak części zdania następującego po tym tytule.

Zmiana szyku zdania w stylu mistrza Yody (np.: “Wojna nikogo wielkim nie czyni.”) również nie wprowadza stylu naukowego a wręcz przeciwnie, czyni tekst śmiesznym i trudnym w odbiorze.

Nie wolno obciążać tekstu przymiotnikami i porównaniami (np.: “kod tak piękny jak poezja Williama Blake’a”). Nie wolno stosować hiperboli (“ogromna biblioteka wymaga przepastnych zasobów dyskowych”).

Jednak nie należy wpadać w drugą skrajność i rezygnować z przymiotników zupełnie. Dopuszczalne są zdania oceniające: “kod jest czytelny”, “kompilacja wymaga dużej przestrzeni dyskowej”. Ocenę należy uszczegółowić i ją uzasadnić: “Kod jest czytelny dzięki licznym komentarzom, które składają się na około 30% zawartości plików źródłowych.”, “Kompilacja wymaga dużej przestrzeni dyskowej - ponad 40 GB.”. Oczywiście pierwsze zdanie w takim podejściu nadal jest subiektywnym zdaniem oceniającym ale zostało poparte pewnym uzasadnieniem, które może stanowić przedmiot merytorycznej dyskusji. Dalsza myśl również jest oceniająca ale została poparta pewną mierzalną czyli weryfikowalną wartością.

Więcej o stylu naukowym można znaleźć w Wikipedii po polsku i po angielsku.

Forma osobowa #

Zdecydowaną większość tekstu pracy należy pisać używając formy bezosobowej, co ułatwia zachowanie obiektywizmu.

W podsumowaniu można umieścić akapit “personalny”. Jest to miejsce, w którym można krótko omówić jak realizacja danej pracy dyplomowej przyczyniła się do rozwoju osobistego autorki/autora. Przykłady takich doświadczeń to poznanie nowej architektury mikroprocesora, odkrycie zainteresowania jakąś tematyką, osiągnięcie w ramach pracy dyplomowej szczególnie bliskie jej autorce/autorowi ze względu na pokonane trudności.

Osobiste mogą być też podziękowania wspomniane w niniejszym poradniku w części “Autorstwo pracy dyplomowej”.

Zamiast:

Lista poniżej prezentuje, na którym sprzęcie mam możliwość realizacji tej aplikacji.

powinno być:

Lista poniżej prezentuje, na którym sprzęcie jest możliwość realizacji tej aplikacji.

Zamiast:

To plik, który znajduje się w naszym projekcie.

powinno być:

To plik, który znajduje się w projekcie.

Zamiast:

Na rysunku widzimy okno programu.

powinno być:

Na rysunku pokazane jest okno programu.

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 nazywam “klejem”. Jest to realizacja postulatów prezentacji pracy w sposób chronologiczny i w oparciu o zwiazki przyczynowo-skutkowe. Można ten cel osiągnąć przez krótkie akapity na końcach lub początkach rozdziałów. Ich istnienie ułatwia odbiór pracy i powrót do czytania takiej pracy po przerwie.

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 oprogramowaniu systemu wbudowanego, realizowanego w ramach niniejszej pracy, jest omówione w kolejnym rozdziale”.

Przykład początku rozdziału: “Podzespoły 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.

Motywacja #

Wiele osób próbuje przedstawić “motywację” w swej pracy dyplomowej, zazwyczaj w rozdziale wstępnym. Ten niepokojący trend zapewne wynika z anglicyzacji języka polskiego.

Motywacja obejmuje oddziaływania biologiczne, emocjonalne, społeczne i poznawcze skłaniające do działania w określonym celu.

Motywacją może być kawałek czekolady (biologiczne), perspektywa dobrej pracy (społeczne) albo inspirujący do pisania ładny widok za oknem (emocjonalne). Czy motywacja jest więc istotna dla czytającego pracę dyplomową? Jest to przecież prywatna, indywidualna i subiektywna sprawa autorki lub autora, co ją i jego motywowało do pisania. Dlatego o swej motywacji nie należy pisać w pracy dyplomowej.

Zamiast tego można przedstawić obiektywne “powody podjęcia tematu”, czyli motywację wyłącznie w zakresie aspektu poznawczego.

Skład tekstu #

Realizując pracę dyplomową w LaTeXu z użyciem szablonu zgodne z obowiązującymi na uczelni wytycznymi niemal nie trzeba przejmować się prawdiłowym składem tekstu. Są jednak takie elementy, o które zadbać należy.

Tekst w rozdziałach numerowanych #

W każdym rozdziale i podrozdziale numerowanym musi znaleźć się jakiś tekst, choćby był to jeden akapit opisujący to, co czytelnik znajdzie w podrozdziałach i dalszych akapitach. Powinien to być akapit a nie jedno zdanie. Niedopuszczalne jest otwieranie rozdziału numerowanego i zaraz pod nim podrozdziału numerowanego:

Rozdział 1

1.1. Podrozdział

Treść. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Prawidłowa struktura to

Rozdział 1

Treść. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

1.1. Podrozdział

Treść. Aliquam tristique non ipsum non fermentum. Donec a dapibus lectus.

Wiszące znaki #

Samotne literki na końcach wierszy nie są zgodne z polską tradycją typograficzną, wyglądają źle i utrudniają płynne czytanie w naszym języku. Dlatego łączy się je z następującymi po nich słowami za pomocą tak zwanej “twardej spacji”. W LaTeX używa się do tego znaku tyldy, tak jak w poniższym przykładzie:

Hobbit, czyli tam i~z~powrotem

Tę modyfikację można wprowadzić na koniec pisania pracy. Wystarczy automatycznie wyszukać i zamienić wszystkie ciągi " i " na " i~", " z " na " z~" i tak dalej. Koniecznie trzeba zwrócić uwagę na spację poprzedzającą spójnik!

Jednostki #

Jednostki przy liczbach muszą być oddzielone “twardą” spacją od tej liczby. Dla powszechnie stosowanych jednostek używamy ich symboli a nie nazw.

100 stopni Celsjusza  % źle - zapis tekstem
451 F % źle - brak symbolu stopnia
273,12 K % źle - brak twardej spacji

% Wystarczająco dobrze:
100~\textcelsius
\makebox{451 \textdegree F}
273,12~K

% Lepiej:
\RequirePackage{siunitx} % w nagłówku lub pliku .cls
\ang{52;14;13.3764}~N