Zasady redagowania pracy

Przedstawione niżej zasady są odpowiedzią na ciągle powtarzające się błędy występujące w pracach. Poniższa lista będzie się rozrastać.

Forma wypowiedzi, styl narracji

Opracowania naukowe i teksty techniczne piszę się zwykle z formie bezosobowej, pozbawionej emocjonalności, wolnej od kolokwializmów i żargonu informatycznego. Uważam jednak, że w pracy inżynierskiej, stanowiącej raport z realizacji własnego rozwiązania informatycznego, można stosować formę osobową (pierwsza osoba liczby pojedynczej dla prac samodzielnych). Forma osobowa wzmacnia zindywidualizowany przekaz autorski. Należy jednak dość konsekwentnie stosować w całej pracy jedną wybraną formę.

Przykład „ortodoksyjny”

W proponowanym projekcie wykorzystany zostanie język C# oraz biblioteka WPF. Dane zapisywane będą w plikach XML z wykorzystaniem bibliotek dostępnej w środowisku Visual Studio.
W proponowanym projekcie wykorzystam język C# oraz bibliotekę WPF. Dane zapisywać będą w plikach XML, wykorzystam bibliotekę dostępną w środowisku Visual Studio.

Przykład „rozluźniony”

Zbyt konsekwentne trzymanie się formy osobowej prowadzi do dziwnych, po sztubacku egzaltowanych form wypowiedzi, rodem z pamiętnika gimnazjalistki. Zatem zamiast:

W proponowanym projekcie wykorzystam język C# oraz bibliotekę WPF. Dane zapisywać będą w plikach XML, wykorzystam bibliotekę dostępną w środowisku Visual Studio.

W proponowanym projekcie wykorzystam język C# oraz bibliotekę WPF. Dane zapisywane będą w plikach XML z wykorzystaniem bibliotek dostępnej w środowisku Visual Studio.

Język, żargon, kolowializmy

Praca inżynierska ma być konkretem dowodzącym wysokich kompetencji autora w zakresie rozwiązywania nietrywialnych problemów z zakresu informatyki. Na podstawie oddanej pracy, po pozytywnie zakończonej obronie, autor otrzymuje tytuł inżyniera potwierdzający wyższe wykształcenie. Aspirowanie do posiadania wykształcenia wyższego zobowiązuje, w pracy należy posługiwać się poprawnym językiem polskim, przestrzegać ogólnie przyjętych zasad ortografii, gramatyki i interpunkcji. W pracy nie należy używać kolokwializmów, żargonu informatycznego, zwracać się do czytelnika per „ty”, stosować wypowiedzi nadmiernie egzaltowanych oraz unikać wszelkiego bełkotu, a szczególnie marketingowego. Zatem w pracy nie piszemy, że coś „nie pykło”, nie stosujemy „frameworków” (a tym bardziej „frejmłorków”), „ticketów”, „commitów”, nie szukamy „bugów”. Dla większości nieakceptowalnych akademicko sformułowań obcych (akceptowalny jest np. interfejs) poszukujemy polskojęzycznych odpowiedników. Zatem stosujemy „pakiety szablonowe”, przyjmujemy „zgłoszenia”, „zatwierdzamy” zmiany, szukamy „błędów”. Nie wymyślamy nieistniejących w języku polskim słów, takich „funkcjonalności”, nawet jeżeli pojawiają się one na dziesiątkach stron internetowych. Ostrzeżenie: nie dopuszczę do obrony pracy w której autor pisze o tym że: „program ma wiele funkcjonalności”, „ta funkcjonalność jest bardzo ważna”, „można dodać kolejne funkcjonalności”. Nie ma słowa „funcjonalności”.

Czytelnikami pracy dyplomowej są członkowie społeczności akademickiej — zarówno wykładowcy jak i inni studenci. Najważniejszym czytelnikiem jest Recenzent. Od jego oceny zależy w dużej mierze wynik obrony. Proszę zatem nie pisać w pracy „zaraz pokażę ci”, „zobaczysz w następnym rozdziale”, „opadnie ci szczęka jak pokażę ci”. Wszelki bełkot marketingowy jest surowo zakazany, czyli niedopuszczalne są sformułowania takie jak „…zastosuję potężną bibliotekę X…”, „…zastosowanie pakietu Y sprawia iż problemy rozwiązują się same…”, „…niekończąca się elastyczność oraz porażająca skuteczność języka Z…”.

Podział na podrozdziały

Każdy rozdział i podrozdział powinien posiadać swój numer, wchodzący automatycznie do spisu treści pracy. Spis treści umieszcza się na początku pracy, przed wstępem. Zwykle wstęp i zakończenie pracy nie są numerowane, ale ze względu na mechanizmy automatyzacji w procesorach tekstu, numery przy wstępie i zakończeniu są dozwolone.

Każdy rozdział pierwszego poziomu musi się rozpoczynać krótkim wprowadzeniem opisującym co rozdział zawiera, dlaczego powstał, w jaki sposób jest powiązany z tematem pracy. Dopiero potem można rozpocząć pierwszy podrozdział.

Przykład

Rozdział ten zawiera charakterystykę wybranych serwerów baz danych, których wydajność będzie analizowana w części badawczej pracy. Omówione zostaną serwery Z, Y, Z, przedstawione zostaną informacje o producencie, sposobie licencjonowania, wymaganiach instalacyjnych, dostępnych mechanizmach definiowania schematów bazy, tabel oraz metodach tworzenia i optymalizacji zapytań. Rozdział zakończy porównanie wybranych właściwości funkcjonalnych w postaci zestawienia tabelarycznego.

Rozdział pierwszego poziomu jest podstawową jednostką organizacji tekstu. Nie może być on nadmiernie krótki, ani przesadnie długi. Zakładając, że docelowa objętość pracy to np. 60, oraz że dzielimy ją na 4 rozdziały (nie licząc wstępu i zakończenia), zrównoważona struktura pracy powinna skutkować rozdziałami o objętości 10-20 stron. Duże dysproporcje w objętości rozdziałów są zwykle rezultatem niewłaściwego przemyślenia struktury pracy. A to może powodować obniżenie jaj oceny.

Nie należy przesadzać z głębokością zagnieżdżenia podrozdziałów. Zwykle numerujemy podrodziały aż do trzeciego poziomu zagnieżdżenia.

Bibliografia i jej znaczenie

Każda praca musi posiadać bibliografię, zawierającą uporządkowany (np. alfabetycznie, narastająco wg. nazwisk autorów) spis materiałów źródłowych wykorzystanych w pracy. Bibliografia umieszczana jest na końcu pracy. Spotyka się różny sposób podziału materiałów źródłowych. W najprostszej postaci jest to jednolita lista uporządkowana alfabetycznie według nazwisk autorów lub kolejności pojawiania się odsyłaczy w tekście.

Rozbudowana bibliografia zawierająca wartościowe źródła informacji świadczy to tym, że autor pracy jest solidnie się przygotował do jej napisania.

Proszę nie lekceważyć bibliografii! Recenzent na pewno sprawdzi czy ona jest, ile liczy pozycji, jakiego rodzaju materiały się na niej znajdują. Materiały źródłowe oraz sposób ich wykorzystania są oceniane w recenzji pracy. To, w jaki sposób jest ona sformatowana, nie jest również bez znaczenia.

Każda pozycja umieszczona w bibliografii musi być przynajmniej raz zacytowana. W pracy nie należy cytować materiałów, które nie są umieszczone w bibliografii.

zalecenia odnośnie bibliografii:

  1. Nie mniej niż 10 pozycji (praca inżynierska), 20 pozycji (praca magisterska).
  2. W bibliografii powinny to być głównie solidne książki, również ebooki i inne dokumenty dostępne elektronicznie. Proszę zrezygnować z Wikipedii jako źródła.
  3. Dokumenty dokumenty elektroniczne dostępne online via Internet powinny mieć normalny opis bibliograficzny a nie tylko wpis zawierający ich URL.
  4. Można umieszczać w bibliografii wpisy na stronach internetowych, blogach, z zachowaniem powyższej uwagi.
  5. Proszę korzystać z mechanizmów automatyzacji dostępnych w popularnych procesorach tekstu. One na prawdę ułatwiają życie i pozwalają na uniknięcie szkolnych błędów w opisach bibliograficznych.

Korzystanie z bibliografii — cytowania

Każdy fragment tekstu pochodzący z materiałów źródłowych musi zostać opatrzony stosownym odsyłaczem, tzw. „cytowaniem” (uwaga — nie chodzi tutaj o wstawienie tekstu w cudzysłowach). Cytowanie polega na wskazaniu źródła informacji poprzez wskazanie jego pozycji w bibliografii. Częste cytowanie różnorodnych źródeł dowodzi oczytania i elokwencji autora.

Spotyka się dwa rodzaje cytowań. Pierwszy to umieszczenie pod koniec cytowanego fragmentu numeru cytowanej pozycji na liście w bibliografii, np.: „… zgodnie z definicją przedstawioną w [1] …”. Drugi rodzaj to wykorzystywanie przypisów dolnych. Proszę nie stosować odnośników w postaci przypisów dolnych.

Zwracam uwagę, że umieszczanie w pracy przepisanych (bądź skopiowanych) dosłownie fragmentów nie jest dozwolone. Jest to plagiat. Również nie jest dozwolone umieszczanie fragmentów tekstu opartych na materiałach źródłowych bez ich zacytowania. W przypadku rozdziałów pracy, mających charakter przeglądu literaturowego, naturalnym jest korzystanie z materiałów źródłowych. Nikt od studenta nie wymaga np. wymyślenia genezy Internetu, usług internetowych czy podstawowych pojęć z zakresu e‑marketingu. Jednak dokonując takiego przeglądu należy pisać „własnymi słowami”, cytując wykorzystywane prace, nawet, jeżeli jest ich wiele. Uwaga — cytowanie nie uprawomocnia przepisywania! Przepisanie z materiałów źródłowych całej strony i opatrzenie cytowaniem, nie zmienia faktu, iż autor umieścił w pracy fragment, którego autorem jest ktoś inny.

Kiedy cytujemy pozycje źródłowe?

  1. Kiedy przytaczamy dosłownie pewne treści, np. definicje, wzory, pojęcia, reguły. Nie wymyślamy ich przecież, nie są one nasze. Zatem cytujemy. Można w treści wstawiać odpowiednie sformułowania, np.: „… w pracy [1] znaleźć można następującą definicję…”, „Opierając się na pracy [7] można stwierdzić…”. dotyczy to również rysunków, schematów, tabel.
  2. Kiedy chcemy podeprzeć swoje stwierdzenia, tezy, sugestie wiarygodnymi inspiracjami, np. „… podobnie jak autor pracy [7] uważam, że ….”, „… przedstawione w pracy podejście jest podobne do opisywanego w [9]…”.
  3. Kiedy chcemy odesłać czytelnika pracy do materiałów źródłowych zawierających więcej szczegółowych informacji, np. „… więcej szczegółów na ten temat znaleźć można w pracy [7]”, „… szczegółowy opis funkcji oferowanych przez moduł zawiera [10]”.

Rysunki, tabele

Rysunku umieszczamy w tekście jako wyśrodkowane, zapewniając odstęp rzędu 6 pkt. od tekstu. Raczej nie stosujemy „oblewania” tekstem rysunku. Każdy rysunek powinien mieć podpis opatrzony odpowiednią etykietą i numerem („Rys. 4 Treść podpisu”, „Rysunek 5 Treść podpisu”). Podpisy umieszczane są oczywiście pod rysunkami. Proszę używać mechanizmów automatyzacji wstawiania podpisów. Nie ma wymogu drukowania pracy w kolorze, chyba że ma to istotne znaczenie (praca dotyczy grafiki komputerowej). Przy wydruku czarno-białym proszę zadbać o czytelność rysunków w oryginale kolorowych.

Tabele umieszczamy w tekście jako wyśrodkowane, zapewniając odstęp rzędu 6 pkt. od tekstu. Również raczej nie stosujemy „oblewania” tekstem rysunku. Każda tabela powinna posiadać nagłówek opatrzony odpowiednią etykietą i numerem („Tab. 4 Treść nagłówka”, „Tabela 5 Treść nagłówka”). Nagłówki umieszczane są oczywiście nad tabelami. Proszę używać mechanizmów automatyzacji wstawiania nagłówków.

Każdy rysunek wstawiony do pracy powinien być opatrzony informacją o źródle, z którego pochodzi (odsyłacz do odpowiedniej pozycji w bibliografii). W przypadku rysunków, które wymyślił, zaprojektował i sporządził sam autor, jako źródło przyjmuje się „opracowanie własne”. Rysunek opracowaniem własnym nie jest, jeżeli opiera się na rysunku cudzym, nawet, jeżeli nie jest skopiowany czy zeskanowany. Jeżeli rysunek źródłowy stanowi tylko inspirację, a ten zamieszczony w pracy różni się od oryginału, uznajemy, że źródło to opracowanie własne na podstawie rysunku źródłowego. Przez domniemanie przyjmuje się, że każdy rysunek bez informacji o źródle stanowi opracowanie własne.

Obowiązuje nadrzędność tekstu nad rysunkami i tabelami. Treść rozdziału musi rozpoczynać przynajmniej jednozdaniowy tekst, tuż po nagłówku rozdziału czy pod rozdziału nie może występować od razu rysunek czy tabela. Do każdego rysunki i każdej tabeli w tekście musi wystąpić odwołanie, np. „Rys. 1 prezentuje…”, „na Rys. 3 przedstawiono…”, „Tab. 3 zawiera zestawienie wyników…”. Proszę wstawiać odwołania do rysunków i tabel z wykorzystaniem mechanizmu automatyzacji dokumentu. Uwaga: proszę nie stosować sformułowań „… na rysunku poniżej…”, „… powyższa tabela…” tylko stosować odwołania z konkretną etykietą i numerem. Dzięki temu rysunek czy tabela do której się odnosimy nie musi znajdować się dokładnie obok odwołującego się tekstu, co pozwala na umieszczanie tekstu czy tabeli wcześniej albo później w tekście, tak aby zoptymalizować wykorzystanie miejsca na stronie.

Spisy rysunków i tabel umieszcza się na końcu pracy, po bibliografii. Informacje o nich powinny one być włączone do spisu treści.

Interpunkcja

Kropki, kropki, kropki….

Po tytule pracy i po tytułach rozdziałów i podrozdziałów nie stawiamy kropek.

W wypunktowaniach i wyliczeniach obowiązuje interpunkcja

Po tytule pracy i po tytułach rozdziałów i podrozdziałów nie stawiamy kropek. W wypunktowaniach i wyliczeniach stosujemy znaki interpunkcyjne. Jeżeli treści w podpunktach zaczynają się od litery dużej, to stanowią one zdanie, i na ich końcu powinna być kropka. Jeżeli treści zaczynają się od litery małej, to całe wypunktowanie albo wyliczenie stanowi jedno duże zdanie, i poszczególne podpunkty powinny być zakończone przecinkiem lub średnikiem, a na samym końcu powinna znaleźć się kropka kończąca to — często dość długie — zdanie.

Przykład

Wyliczenie w postaci osobnych zdań:

  1. Zdanie pierwsze.
  2. Zdanie drugie.

Wyliczenie w postaci jednego zdania:

  1. fragment pierwszy,
  2. fragment drugi.

Na końcu tytułu pracy, na końcu tytułów rozdziałów i podrozdziałów nie stawiamy kropek.