ZASADY PISANIA PRAC DYPLOMOWYCH
Kazimierz Jakubczyk, 10 czerwca 2008
1. Uwagi ogólne
Praca dyplomowa inżynierska z dziedziny informatyki stanowi rozwiązanie postawionego zadania praktycznego przy użyciu technologii informatycznych. Praca dyplomowa magisterska stanowi rozwiązanie postawionego zagadnienia wykorzystujące zarówno technologie informatyczne jak i naukową analizę problemu. Praca dyplomowa składa się z:
analizy zagadnienia stanowiącego przedmiot pracy na tle aktualnego stanu wiedzy i dostępnych technologii,
prezentacji i analizy rozwiązania postawionego zagadnienia,
dokumentacji projektu informatycznego w postaci zgodnej z regułami dokumentowania projektów.
Kod źródłowy (program komputerowy, witryna internetowa itp.) stanowi załącznik do części pisemnej w formie elektronicznej (płyta CD-ROM). Praca dyplomowa może przedstawiać wyniki o niemożności rozwiązania postawionego zagadnienia przy użyciu dostępnych środków. Wyniki takie muszą być poparte szczegółowa analizą.
Ocenie podlegają między innymi poprawność i ścisłość argumentacji, zwięzłość, jasność i jednoznaczność sformułowań, styl programowania, pełność analizy i dokumentacji rozwiązania. Praca dyplomowa inżynierska otrzymująca ocenę bardzo dobrą (5,0) powinna stanowić rozwiązanie postawionego zagadnienia na poziomie profesjonalnym, niebudzące istotnych zastrzeżeń. Praca dyplomowa magisterska otrzymująca ocenę bardzo dobrą powinna zawierać elementy nowatorskie lub twórcze rozwiązanie postawionego zagadnienia.
2. Układ strony
Pracę dyplomową należy przygotować w formacie A4, przyjmując w tekście interlinię 1,5 wiersza, margines górny, dolny i zewnętrzny 2,5 cm, margines wewnętrzny 3,5 cm (margines 2,5 cm + na oprawę 1 cm). Numery stron powinny być umieszczone u dołu strony (stopka) lub u góry (nagłówek) po prawej stronie. W przypadku wydruku dwustronnego numery stron powinny występować po prawej stronie na stronach nieparzystych, a po lewej - na parzystych. Jeżeli numery stron i tytuły elementów składowych pracy występują u góry strony, nie mogą pojawiać się na początkowych stronach tych elementów. Objętość pracy inżynierskiej powinna wynosić około 40 stron, zaś magisterskiej od 50 do 70 stron.
3. Układ pracy
Praca powinna mieć strukturę 2-poziomową (podział rozdziałów na podrozdziały). Struktura pracy powinna być następująca:
strona tytułowa w postaci standardowej (bez numeracji),
strona druga (bez numeracji) obejmująca streszczenie pracy w języku polskim (300-500 znaków), słowa kluczowe (3-6), tytuł pracy w języku angielskim, streszczenie w języku angielskim (300-500 znaków), słowa kluczowe w języku angielskim (key words, 3-6),
automatyczny spis treści,
wstęp,
kolejne rozdziały w układzie zgodnym ze spisem treści (3-5),
podsumowanie (zakończenie),
literatura (bibliografia),
załączniki (opcjonalnie).
Tytuł pracy powinien być napisany dużymi literami czcionką 16 pt. pogrubioną, wycentrowany, bez kropki na końcu. Pozostałe napisy na stronie tytułowej mają być pisane czcionką 14 pt. Rozmiar czcionki tekstu normalnego powinien wynosić 12 pt., typ czcionki Times New Roman. Przyjęte style formatowania powinny być jednolite w całej pracy. Rozdziały mają się rozpoczynać od nowej strony, tytuły rozdziałów powinny być pisane dużymi literami (dotyczy to również spisu treści, wstępu, podsumowania i literatury). Wstęp powinien określać cel i genezę pracy, a także zawierać krótką prezentację treści poszczególnych rozdziałów i zawartości załączonej płyty CD-ROM. Rozdziały powinny być numerowane od 1 wzwyż. Podrozdziały powinny mieć numerację podwójną (numer rozdziału, kropka i numer kolejny podrozdziału w ramach rozdziału, np. 1.1, 1.2, 2.1, 2.2 itp.
Układ pracy powinien być logiczny i poprawny pod względem metodologicznym. Podczas pisania pracy należy kierować się zasadą kompletności (uwzględnienie wszystkich ważnych elementów i unikanie zbędnych), podporządkowania (każda część pracy powinna wynikać z tematu pracy i przyjętej koncepcji rozwiązania postawionego zadania, każda następna część pracy powinna stanowić konsekwentnie ciąg dalszy i logiczną kontynuację części poprzedniej) i wyłączności (tego samego zagadnienia nie należy omawiać wiele razy w różnych miejscach pracy, lecz tylko raz w sposób logiczny i całościowy). W przypadku pracy o charakterze informatycznym poszczególne rozdziały powinny obejmować następujące treści:
przegląd aktualnego stanu wiedzy w zakresie rozwiązywanego problemu (przegląd literatury i oprogramowania);
szczegółowe sformułowanie tematyki pracy i merytoryczne określenie zakresu prac (co w pracy powinno być zrobione);
opracowanie projektu (algorytmy, schematy, przyjęte rozwiązania);
realizacja projektu (rozwiązanie zadania, interesujące fragmenty kodu);
weryfikacja, testowanie i instrukcja obsługi stworzonego produktu.
Każdy rozdział powinien kończyć się zwartym podsumowaniem stwierdzającym, co w nim zostało zrobione i ewentualnie sugerującym lepsze lub alternatywne rozwiązanie. Podsumowanie końcowe powinno zawierać syntetyczne wnioski.
4. Przypisy, odsyłacze, cytaty, skrótowce
Przypisy są umieszczane u dołu stron, których dotyczą (por. przypis na poprzedniej stronie). Powinny być numerowane od 1 wzwyż w ramach całej pracy. W pracach o charakterze technicznym i naukowym, np. w pracach informatycznych, przypisy nie powinny być odsyłaczami do literatury (pozycji bibliograficznych), lecz zawierać komentarze, objaśnienia i uwagi dodatkowe autora odnoszące się do wskazanych wyrazów, zwrotów lub fragmentów tekstu.
Odsyłacze do literatury wyszczególnionej w wykazie końcowym są podawane bezpośrednio w tekście pracy i mają postać numerów ujętych w nawiasy kwadratowe z ewentualnym podaniem strony publikacji, np. [5] lub [5, s. 127]. Odsyłacze pełnią bardzo ważną rolę - wskazują czytelnikowi, z jakich źródeł korzystał autor pracy. Wykorzystanie cudzych myśli lub wywodów bez podania źródła świadczy o tym, że praca jest plagiatem.
Cytaty zaczerpnięte z literatury powinny być oznaczone w tekście pracy cudzysłowami - otwierającym i zamykającym: „tekst cytatu”. Cytaty powinny być całkowicie zgodne ze źródłem oryginału, nawet gdy występują w nich odstępstwa od aktualnie obowiązującej pisowni, interpunkcji itp. Nieistotne fragmenty cytatu mogą być pominięte, należy je jednak zaznaczyć, stosując wielokropek w nawiasie: „fragment cytatu […] fragment cytatu”. Zamieszczając cytat, należy podać odsyłacz do literatury ze wskazaniem numeru strony. Podając autora cytatu, należy wymienić tylko pierwszą literę imienia i nazwisko, np. E. Dijkstra wypowiedział słynne zdanie, że „testowanie może wykazać istnienie błędów, lecz nie ich brak” [8, s. 177].
Przy pierwszym wystąpieniu skrótowca w tekście pracy należy podać w nawiasie jego objaśnienie, np. NWD (największy wspólny dzielnik) lub IDE (ang. Integrated Development Environment - zintegrowane środowisko programistyczne).
5. Spis literatury
Spis (wykaz) literatury (bibliografii) powinien obejmować wszystkie źródła informacji, do których w tekście pracy występują odsyłacze. Błędem jest zamieszczenie pozycji, do której nie ma odsyłacza. Pozycje powinny być uporządkowane alfabetycznie według nazwisk autorów i opatrzone kolejnym numerem ujętym w nawiasy kwadratowe. Spis powinien być podzielony na tradycyjne publikacje (opracowania książkowe, czasopisma, prace dyplomowe, dzienniki ustaw itp.) i strony internetowe. Zapis źródła informacji powinien zawierać elementy:
dla pozycji książkowej - dane autora (nazwisko i imię lub skrót imienia), tytuł książki, nazwa wydawcy, miejsce i rok wydania, numer ISBN;
dla artykułu w książce - dane autora i tytuł artykułu, a po symbolu [w:] dane redaktora, tytuł książki, nazwa wydawcy, miejsce i rok wydania, strony, numer ISBN;
dla czasopisma - dane autora (jeśli istnieją), tytuł artykułu i nazwa czasopisma, tom lub numer, rocznik, strony;
dla publikacji internetowej - dane autora i tytuł artykułu (jeżeli istnieją), adres strony WWW i data publikacji.
Nazwę wydawcy można skrócić, jeśli jest łatwa do zidentyfikowania (np. WSiP zamiast Wydawnictwa Szkolne i Pedagogiczne). W przypadku kolejnych wydań książki należy podać o nich informacje, a także informacje o zmianach, jeśli miały miejsce (np. wyd. 3 poprawione i uzupełnione). Jeżeli data publikacji internetowej jest nieznana, należy podać datę jej pozyskania lub grupę publikacji internetowych poprzedzić informacją: Według stanu w okresie… W przypadku dokumentu elektronicznego należy podać w nawiasie kwadratowym typ nośnika (np. [CD-ROM]). Zgodnie z nowymi normami opisu bibliografii obowiązkowym elementem jest numer ISBN (ang. International Standard Book Numer). Oto przykładowy wykaz literatury:
BAŃKO Mirosław (red.): Polszczyzna na co dzień, PWN, Warszawa 2006. ISBN: 83-01-14793-8.
Borland Turbo Delphi/C++ Explorer, PC Word Komputer 11/2006, s. 188.
ECKEL Bruce: Thinking in C++. Edycja polska, Helion, Gliwice 2002. ISBN: 83-7197-709-3.
KERNIGHAN Brian W., RITCHIE Dennis M.: Język ANSI C, WNT, Warszawa 2007, wyd. 10. ISBN: 978-83-204-3356-2.
MODZELEWSKI Mirosław: Klasyfikacja i kryteria oceny edukacyjnych programów komputerowych, [w: ] ŁASZCZYK Jan (red.): Komputer w kształceniu specjalnym, WSiP, Warszawa 1998, s. 21-34. ISBN: 83-02-06711-3.
OETIKER Tobiasz, PARTL Hubert, HYNA Irene, SCHLEGL Elizabeth: The Not So Short Introduction to LATEX 2ε, Version 4.24, February 08, 2008, http://tobi.oetiker.ch/lshort/lshort.pdf, [plik lshort.pdf, licencja GNU] (z dn. 11.02.2008).
http://msdn63.e-academy.com/pr_nauc (z dn. 17.05.2007).
6. Prezentacja kodu, rysunki i tabele
Oto przykład wydruku kodu programu (styl Listing, gdy stosujemy szablon Praca.dot). Funkcja n! opisana matematycznie za pomocą wzoru rekurencyjnego:
może być zaprogramowana w językach C i C++ następująco:
int Silnia(int n)
{
if (n>1)
return n*Silnia(n-1);
else
return 1;
}
Rysunek opisujemy u dołu (styl Rysunek), podając numer, tytuł i źródło pochodzenia (odsyłacz do literatury z numerem strony), gdy rysunek nie został opracowany przez autora. Rysunki numerujemy od 1 wzwyż w ramach całej pracy. Rysunek wstawiamy tuż po akapicie, w którym po raz pierwszy występuje do niego odwołanie (np. rys. 1). Zamieszczenie rysunku bez odwołania jest błędem. Jeżeli rysunek wraz z opisem nie mieści się na bieżącej stronie, umieszczamy go na następnej. Wówczas, jeżeli na bieżącej stronie jest wolne miejsce, piszemy tam kolejny akapit.
Rys. 1. W sierpniu 2002 na Marmoladzie
Tabelę opisujemy u góry (styl Tabela), podając numer kolejny i tytuł. Tabele numerujemy podobnie jak rysunki - od 1 wzwyż w ramach całej pracy. Pod tabelą podajemy źródło jej pochodzenia (styl Źródło) - odsyłacz do literatury z numerem strony. Jeśli źródła pisanego nie ma, bo została stworzona przez autora pracy, piszemy: Źródło: opracowanie własne. A teraz przykład - w tabeli 1. przedstawione są najważniejsze rodzaje złożoności algorytmów.
Tabela 1. Rodzaje złożoności algorytmów
Notacja |
Rodzaj złożoności |
Przykład |
|
stała |
indeks tablicy |
|
logarytmiczna |
przeszukiwanie dwójkowe |
|
liniowa |
porównywanie napisów |
|
liniowo-logarytmiczna |
sortowanie szybkie |
|
kwadratowa |
proste algorytmy sortowania |
|
sześcienna |
mnożenie macierzy |
|
wykładnicza |
dzielenie zbioru na części |
Źródło: [2, s. 63]
W podobny sposób jak tabele (u góry) można opisywać dłuższy kod źródłowy, tj. całe programy lub ich fragmenty, teksty HTML itp. (styl Listing), ale bez podawania źródła, bo kod jest zazwyczaj wymyślony przez autora. Aby kod był dobrze widoczny, można go oddzielić od opisu linią poziomą. Brak odwołania do rysunku, tabeli lub opisanego kodu (listingu) oznacza, że element ten jest zbyteczny! Należy go usunąć lub wstawić do niego odwołanie.
7. Uwagi redakcyjne
Ważne jest, aby poszczególne elementy tekstu pracy wyróżniały się, bo wtedy łatwiej ją czytać i analizować. Tekst należy formatować, operując stylami, a nie poprzez bezpośrednią zmianę kroju lub wyglądu czcionek. Jeśli różne fragmenty pracy są pisane odmiennymi stylami, istnieje uzasadnione przypuszczenie, że praca jest ściągana z różnych książek, czasopism lub Internetu. Oto szczegółowe uwagi redakcyjne:
Nie wstawiamy więcej niż jedną spację między wyrazami.
Nie wciskamy Enter (ani Shift+Enter) na końcu wiersza wewnątrz akapitu. Klawisz ten służy wyłącznie do oddzielania (kończenia) akapitów.
Przy wykorzystaniu szablonu Praca.dot wcięcie akapitowe pierwszego wiersza akapitu tworzymy, naciskając klawisz Tab.
Nie wstawiamy spacji między nawiasem i tekstem w nawiasie.
Nie umieszczamy kropki na końcu tytułu.
Nie wstawiamy spacji przed znakiem interpunkcyjnym (kropka, wykrzyknik, pytajnik, przecinek, dwukropek, średnik), natomiast po takim znaku umieszczamy spację, gdy występuje po nim kolejne słowo akapitu.
Nie pozostawiamy na końcu wiersza słów jednoliterowych: a, i, o, u, w, z. Pomiędzy takim słowem a następnym wstawiamy tzw. twardą spację (klawisze Ctrl+Shift+spacja).
Sprawdzamy pisownię za pomocą narzędzia Pisownia i gramatyka lub Narzędzia sprawdzające (klawisz F7).
Rozróżniamy łączniki (-) i myślniki (-). Łączniki (znak minus) stosuje się do łączenia wyrazów, np. klient-serwer, kod pocztowy 26-600, numer telefonu 361-78-50, pokój 4-osobowy, w latach 1997-2000. Myślnika (znak minus na klawiaturze numerycznej przy wciśniętym klawiszu Ctrl) używa się do wtrącania wyrażeń, np. serwer - główny komputer w sieci - jest zazwyczaj drogi.
Numeracja rysunków, tabel, wydruków programów (listingów) i przypisów jest jednolita w całej pracy. Numery dla każdej z tych kategorii rozpoczynają się od 1 i zwiększają o 1. Powtórzenia i przerwy w numeracji są niedozwolone.
Numer strony nie występuje na stronie tytułowej pracy i stronach zawierających streszczenia w języku polskim i angielskim. Jeśli strony są numerowane na górze (styl Pagina w nagłówku strony), numery stron (i nagłówki) nie występują na początkowych stronach rozdziałów (dotyczy to też spisu treści, wstępu, podsumowania i literatury). Jeśli strony są numerowane na dole (w stopce strony), numery stron (i stopki) występują również na stronach rozpoczynających rozdziały.
Nie przenosimy na następną stronę i nie pozostawiamy na poprzedniej stronie pojedynczych wierszy tekstu (tzw. wdowy i bękarty).
Wyróżniamy polecenia menu (np. Plik→Zapisz jako), nazwy okien, przycisków, opcji i innych elementów graficznych (np. OK, Anuluj), katalogów (folderów) i plików (np. C:\Teksty\Word), adresy internetowe (np. www.pr.radom.pl), oznaczenia klawiszy (np. Esc, Shift+Enter) oraz nazwy zmiennych i stałych definiowanych przez użytkownika (np. n, Delta).
Aby Word nie podkreślał adresów internetowych, wyłączamy opcję Narzędzia→Autokorekta→Autoformatowanie podczas pisania→Ścieżki internetowe i sieciowe na hiperłącza. W podobny sposób można wyłączyć inne elementy autokorekty, które sprawiają kłopot przy pisaniu pracy.
Styl Kod można używać do oznaczania kodu źródłowego użytego bezpośrednio w tekście oraz adresów internetowych, słów kluczowych, poleceń systemowych itp. Pełne wydruki (listingi) programów lub ich fragmentów formatujemy za pomocą stylu Listing.
Styl Normalny służy do powrotu w tekście do stylu standardowego po innych stylach.
Aby uniknąć dużych odstępów między wyrazami, gdy tekst jest justowany, możemy przeniesione do następnego wiersza słowo podzielić na sylaby, stosując tzw. łącznik opcjonalny (Ctrl+-)
Word zachowuje się niekiedy dziwnie przy listach wypunktowanych i numerowanych, pozostawiając duże fragmenty stron puste. Aby uniknąć tego typu zachowań, trzeba stosować różne sztuczki, np. można podzielić listę wierszem pustym z czcionką bardzo małą (1-4 punkty).
Należy uważać na przypisy, ponieważ Word niekiedy potrafi je przenosić na następne strony.
8. Słownictwo
Określenia żargonowe są niepoprawne, należy więc ich unikać. Również terminy obcojęzyczne powinny być zastępowane ogólnie przyjętymi odpowiednikami polskimi, jeśli takie istnieją. Oto lista występujących często słów angielskich i ich odpowiedników polskich:
array tablica (nie: tabela)
button przycisk (nie: button, guzik)
click on (button) kliknąć na (przycisku)
combo box lista rozwijana (nie: pole kombo)
command polecenie (nie: komenda)
controller, driver sterownik
debugging usuwanie błędów (nie: debugowanie)
delete usuwać (nie: kasować)
details szczegóły (nie: detale)
drop-down list lista rozwijana (nie: lista rozwijalna)
encryption szyfrowanie (nie: kodowanie)
error message komunikat o błędzie (nie: komunikat błędu)
fatal error błąd krytyczny (nie: błąd fatalny)
file plik (nie: zbiór)
flag znacznik (nie: flaga)
font czcionka (nie: font)
form formularz (nie: forma, formatka)
hard disk dysk twardy (nie: twardy dysk)
home directory katalog macierzysty (nie: katalog domowy)
home page strona główna (nie: strona domowa)
instance kopia, egzemplarz (nie: instancja)
link łącze, połączenie, hiperłącze (nie: link)
linker program łączący, konsolidator
pin końcówka, wyprowadzenie (nie: pin)
plug-in moduł rozszerzający (nie: wtyczka)
property właściwość (nie: własność)
result wynik (nie: rezultat)
return code wartość zwracana (przez funkcję)
root directory katalog główny (nie: korzeń)
save zapisać (nie: zachować)
source code kod źródłowy, tekst źródłowy
support obsługa (nie: wsparcie, wspomaganie)
table tabela (nie: tablica)
tag znacznik (nie: tag)
9. Pospolite błędy
Do rozdzielenia wyrazów złożonych używa się łącznika (-), nie ukośnika (/). Dlatego np. piszemy: klient-serwer, wejście-wyjście, nie zaś: klient/serwer, wejście/wyjście.
Zwrot za pomocą łączy się z przedmiotami (używanymi jako narzędzia), zaś przy pomocy z osobami (przy współpracy których wykonywana jest jakaś czynność). Piszemy więc np.: za pomocą komputera, za pomocą młotka, a nie: przy pomocy komputera, przy pomocy młotka. Nie piszemy jednak np. za pomocą kolegi, ponieważ właściwym zwrotem jest: przy pomocy kolegi.
Słowo ilość wiąże się z rzeczownikami niepoliczalnymi, natomiast liczba z policzalnymi. Piszemy zatem: ilość cukru, ilość informacji, ale: liczba łyżeczek cukru, liczba stron maszynopisu.
Użycie zaimka tą z biernikiem (kogo-co?) rzeczownika rodzaju żeńskiego jest w słowie pisanym błędem, właściwą formą jest tę. Piszemy zatem: tę książkę, tę panienkę, a nie: tą książkę, tą panienkę.
Nie stawia się kropki po skrótach zawierających pierwszą i ostatnią literę wyrazu skróconego, jeżeli skróty te są użyte w mianowniku. Jeżeli skrót tego typu jest użyty w innym przypadku, stawia się po nim kropkę bądź zapisuje się go w formie odmiennej. I tak, piszemy np.: dr Kowalski powiedział…, zdałem na czwórkę u dr. Kowalskiego, podaj tę książkę dr. Kowalskiemu, a także: zdałem na czwórkę u dra Kowalskiego, podaj tę książkę drowi Kowalskiemu.
Niedozwolona jest forma bezpośredniego zwracania się do czytelnika pracy. Nie wolno np. rozpoczynać rozdziału słowami: W tym rozdziale dowiesz się jak..., ani też instruować czytelnika: Jeśli chcesz wyświetlić plik, naciśnij... Taka poufałość nie tylko nie świadczy o dobrym wychowaniu autora, lecz także stanowi podstawę do podejrzeń, że jego praca jest plagiatem.
Niejednokrotnie na stronach internetowych można spotkać zapis typu: Dziś jest czwartek, 18 luty 2007. Zdanie takie nie jest poprawne, gdyż wynika z niego, że rok 2007 miał co najmniej 18 miesięcy o nazwie luty. Właściwym sformułowaniem jest: Dziś jest czwartek, 18 lutego 2007.
*****
Taki układ ma niniejsze opracowanie.
5
Zasady pisania prac dyplomowych |
|
Wyszukiwarka