Jak pisa prac inyniersk/magistersk

Cezary Sobaniec
v1.6, 2011/05/24

Streszczenie Niniejszy poradnik ma by pomoc dla studentw w pisaniu pracy inynierskiej i pniej magisterskiej a z drugiej strony ma pomc promotorom ograniczajc ich prac do korekty merytorycznej a nie redakcyjnej, ktra moe by wykonana samodzielnie przez studenta. Przedstawione zasady i porady s oglne i mona je stosowa zarwno w A przypadku stosowania edytorw tekstowych (OpenOce, MS Word) jak i systemu L TEX. Poradnik powsta m.in. w oparciu o materiay przygotowane przez Macieja Drozdowskiego i dostpne pod adresem http://www.cs.put.poznan.pl/mdrozdowski/dyd/txt/ jak_mgr.html.

Spis treci
1 Wstp 2 Struktura pracy 3 Styl 4 Skad tekstu 4.1 Czcionka i akapity . . . 4.2 Ukad strony . . . . . . 4.3 Dywiz, mylnik i pauza 4.4 Podzia sw . . . . . . 4.5 Odstpy . . . . . . . . . 4.6 Rozdziay i podrozdziay 4.7 Rysunki i tabele . . . . 4.8 Literatura . . . . . . . . 4.9 Korekta . . . . . . . . . 2 2 3 3 3 4 4 4 4 5 5 5 6 6 6 6 8 1

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

5 Narzdzia A 5.1 L TEX / LYX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.2 OpenOce / Microsoft Word . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Sowniczek ortograczny ;-)

1 Wstp
Zaraz na wstpie chciabym podkreli co, co jak okazuje si nie dla wszystkich studentw jest cakowicie oczywiste. Chodzi o wykorzystanie do pisania swojej pracy magisterskiej zewntrznych materiaw rdowych. Cakowicie naturalnym i czsto wrcz podanym jest powoywanie si na materiay rdowe: ksiki, artykuy w czasopismach, dokumentacj techniczn, czy w wreszcie na wszelkie inne publikacje dostpne w Internecie. Odwoanie do takich materiaw stanowi wsparcie dla tez, ktre chcemy przekaza czy udowodni. Odwoanie moe mie form wskazania na materia rdowy, zawierajce nazwisko autora, tytu i miejsce publikacji oraz dat wydania. Odwoanie moe rwnie mie form cytatu, jednake z wyranym zaznaczeniem cytowanego fragmentu oraz ze wskazaniem na rdo. Cakowicie jednak niedopuszczalne jest kopiowanie do pracy fragmentw tekstw, ktrych nie jestemy autorami. Takie postpowanie to plagiat!

2 Struktura pracy
Praca inynierska/magisterska powinna mie nastpujc struktur: 1. Strona tytuowa. 2. Karta pracy z podpisem dziekana. 3. Spis treci. 4. Wstp z podpunktem opisujcym motywacj, cel oraz zakres pracy. 5. Rozdzia(y) teoretyczny deniujcy(e) rozwaane zagadnienie i opisujcy aktualny stan wiedzy (np. modele matematyczne i wzory, opis stanu rzeczywistoci, procedur biznesowych itp.). 6. Rozdzia(y) opisujcy(e) na wysokim poziomie abstrakcji ide/sposb/metod rozwizania postawionego problemu (np. model powiza midzy danymi, struktura bazy danych, szczegowa specykacja wymaga, diagramy uycia, itp.). 7. Rozdzia(y) opisujcy(e) techniczn stron rozwizania (dokumentacja techniczna, istotne wyjtki z kodu rdowego programw). 8. Rozdzia(y) opisujcy(e) przeprowadzone testy jednostkowe/integracyjne/funkcjonalne/akceptacyjne/efektywnociowe, oraz innego rodzaju uzyskane wyniki wraz z ich analiz. 9. Zakoczenie zawierajce podsumowanie i wnioski. 10. Literatura. 11. Zaczniki. Do pracy naley zaczy dysk CD/DVD uatwiajcy kontynuowanie pracy przez kolejnych studentw. Dysk taki powinien zawiera: peen tekst pracy (np. w formacie PDF), informacje o autorach wraz z adresem kontaktowym (nr telefonu, email), kompletne kody rdowe opracowanej aplikacji wraz z (ewentualnym) repozytorium systemu zarzdzania wersjami (np. CVS lub Subversion), pliki konguracyjne, kopi oglnodostpnej dokumentacji w wersji elektronicznej.

3 Styl
1. Zamiast I osoby liczby pojedynczej (np. (ja) zrobiem, (ja) zaprojektowaem, (ja) zaprogramowaem, (ja) przetestowaem) przyjo si uywa formy bezosobowej (zrobiono, zaprojektowano, zaprogramowano, przetestowano) lub I osoby liczby mnogiej (zrobilimy, zaprojektowalimy, zaprogramowalimy, przetestowalimy). Wydaje si, e najodpowiedniejsza jest forma bezosobowa. 2. Praca powinna da si normalnie czyta tak jak esej lub wypracowanie. Nie powinna by, np., zbiorem list wypunktowujcych rne zagadnienia. 3. Piszc prac z informatyki, naley uywa terminologii informatycznej, ktra ma sprecyzowan tre i znaczenie. Nie powinno si uywa gazetowych okrele typu: silnik programu, maszyna skryptowa, elektroniczny mechanizm, gdy nie wiadomo co one waciwie oznaczaj. 4. Naley unika eleganckiego stylu, gdy najczciej wychodzi styl bombastyczny. Np.: jeden z najznamienitszych przykadw, program niesamowicie prosty w obsudze, proces jest niezwykle trywialny, celem znakomitej wikszoci. 5. Naley unika przesadnie dugich zda. 6. Zdecydowanie naley unika tworzenia nowych sw i uywania argonu. Lepszym rozwizaniem jest uycie bardziej opisowego stylu. Jeli z jaki powodw stosujemy nowe pojcie/zwrot, to koniecznie naley je wyjani przy pierwszym uyciu. Oto kilka zych przykadw: w pracy uyto frameworku XYZ, algorytmy cachujce, deweloperzy, hosty, nowy czer. 7. Maa klarowno tekstu i saba gramatyka s przejawami niezrozumienia tematu. Jeeli czytelnik ma problem ze zrozumieniem, to z duym prawdopodobiestwem mona powiedzie, e autor nie wie co chce powiedzie. 8. Przygotowanie dobrej dokumentacji wymaga czasu. Mona przyj, e 1 strona A4 dobrej dokumentacji wymaga 1 dnia pracy. 9. Przypisy. Naley unika stosowania przypisw. Przypis powinien mie charakter uzupeniajcego tekstu, ktry dodatkowo jest wtrceniem pochodzcym z innego kontekstu. W przypisie nie mona zawiera istotnych treci z punktu widzenia celu pracy.

4 Skad tekstu
4.1 Czcionka i akapity
1. Naley uy czcionki szeryfowej (typu Times lub Computer Modern) o wielkoci od 10 do 13. 2. Przykady kodw rdowych powinny by drukowane czcionk o staej szerokoci (np. Courier). 3. Interlinia nie powinna by wiksza od 1,5. 4. Gwny tekst pracy powinien by wyjustowany (wyrwnany do lewej i prawej).

4.2 Ukad strony

1. Marginesy poziome powinny by z zakresu 2 do 3 cm, pionowe nieco wiksze. Wskazane jest ustawienie niesymetrycznych marginesw, tak aby po zszyciu pracy moliwe byo odczytanie tekstu blisko oprawy. 2. Strony powinny by ponumerowane. Warto doda do dokumentu yw pagin (nagwek dla kadej strony), ktra bdzie zawiera tytu pracy lub (lepiej) tytu rozdziau wraz z numerem strony.

4.3 Dywiz, mylnik i pauza

Dywiz Mylnik Pauza Opis krtka kreseczka uywana do przenoszenia wyrazw i zapisu zbitek typu biao-czarni uywany jest do zapisu zakresu wartoci najpopularniejszy mylnik sucy do oddzielania czci zdania Przykad biao-czarny 1020 on ona
A Zapis w L TEX-u

----

Wok pauzy powinny by wstawiane odstpy, np.:

Pauza --- szczeglnie w jzyku polskim --- peni rol... e e

W przypadku edytorw tekstowych warto zdeniowa regu autokorekty dokonujcej zamiany -- i --- na odpowiednie znaki specjalne i .

4.4 Podzia sw
A 1. Koniecznie naley wczy automatyczne przenoszenie wyrazw. L TEX domylnie dzieli sowa. Edytory tekstowe wymagaj jawnego wczenia tej opcji.

2. Naley unika pozostawiania pojedynczych liter na pocztku i kocu zdania. Jeeli zdanie zaczyna si od spjnika z, w, i, to po spjniku naley wstawi niepodzielny A odstp. W przypadku L TEX-a jest to komenda ~, a w przypadku edytorw bdzie to kombinacja Ctrl-Spacja. Przykad:
W~przypadku \LaTeX-a jest to komenda...

4.5 Odstpy
1. Nie powinno by dodatkowego odstpu przed kropk koczc zdanie, np.:
Zdanie to jest zapisane niepoprawnie .

2. Tekst w nawiasach powinien by zapisany bez dodatkowych odstpw, np.:

Przykadowy przebieg (Rysunek 1.5) prezentuje...
A 3. Jeeli w zdaniu pojawia si skrt z kropk, to naley skasowa (w przypadku L TEX-a) 1 , np.: dodatkowy odstp komend \
1

Komend t mona uzyska w LYX-ie uywajc kombinacji CtrlAltSpacja

z Pan in.\ Kowalski jest dobrym specjalista.

4. Dodatkowy odstp po kropce nie jest dodawany, gdy przed kropk wystpuje dua litera. W takim przypadku naley go wymusi komend \@2 , np.:
Przygotowalimy wniosek do KBN\@. s Wniosek jest...

4.6 Rozdziay i podrozdziay

1. Tytuy rozdziaw i podrozdziaw powinny by zapisywane bez znakw interpunkcyjnych (kropka lub dwukropek na kocu). 2. Rozdziay i podrozdziay powinny by numerowane w sposb hierarchiczny. Do spisu treci powinny tra punkty o maksymalnie trzecim poziomie zagniedenia, czyli np. 2.1.5. 3. Rozdziay powinny rozpoczyna si od nowej strony, na wydruku dwustronnym od strony nieparzystej. Pozostaa tre pracy powinna by pisana jednym cigiem. 4. Naley unika wydzielania pojedynczych podrozdziaw z rozdziaw, np. rozdzia 3 z jedynym podrozdziaem 3.1. W takiej sytuacji naley zrezygnowa z wydzielania podrozdziau lub z jego numerowania.

4.7 Rysunki i tabele

1. Rysunki i tabele powinny mie podpisy cznie z numerem kolejnym, np. Rys. 3.7. Podpis dla rysunku naley umieci pod rysunkiem, podpis dla tabeli powinien znajdowa si nad tabel. 2. Naley unika stosowania graki rastrowej (np. formaty GIF, PNG, JPEG) zastpujc j grak wektorow (np. formaty Postscript, PDF). W przypadku graki rastrowej naley zastosowa odpowiednio du rozdzielczo (150300dpi).

4.8 Literatura
Praca musi zawiera Literatur (lub inaczej pimiennictwo, referencje). Lista Literatura powinna by oddzieln czci pracy, na poziomie rozdziau w strukturze pracy. Kada pozycja w spisie literatury musi zawiera: autora, tytu pracy, wydawnictwo/czasopismo/adres http/ftp, rok publikacji, strony od-do w przypadku artykuw w czasopismach. Lista powinna by posortowana alfabetycznie wedug nazwisk autorw. Pozycje na licie referencji powinny by ponumerowane kolejnymi liczbami naturalnymi. Uywanie skrtw nazwisk autorw lub ich inicjaw w poczeniu z rokiem wydania, np. AB99, jest take akceptowalne. Praca musi zawiera odwoania w tekcie do wszystkich pozycji w literaturze. Preferowana forma odwoa to numer pozycji w spisie zamknity w nawiasach kwadratowych, np. [1], [23]. Odwoania [AB99] s take akceptowalne, jednak wwczas lista pozycji literaturowych musi zawiera te skrty, a nie kolejne numery pozycji. Prosz nie umieszcza odwoa do literatury w stopce strony. Odwoania do numeru strony i linijki, w ktrej co powiedziano w jakim artykule/ksice nie jest podane (bo czsto wyrywa to stwierdzenia z kontekstu). Odwoania do literatury nie powinny wystpowa w tytuach rozdziaw.
2

W LYX-ie Ctrl.

4.9 Korekta
Promotor moe nanie poprawki do pracy stosujc znaki korektorskie. Ich list mona znale np. w poradniku Piotra Hrehorowicza i Magorzaty Punzet dostpnym pod adresem http://www.interline.com.pl/poradnik1.pdf. Warto rwnie zobaczy poradnik dostpny pod adresem http://szkola.wi.ps.pl/html/sklad/sklad.htm. Bardzo obszerny zbir wskazwek dotyczcych typograi mona znale pod adresem http://dtp.msstudio. com.pl/.

5 Narzdzia
A 5.1 LTEX / LYX
A Prace inynierskie/magisterskie pisane w L TEX-u mona przygotowa w oparciu o klas dcsbook, ktrej aktualne rda s dostpne na stronie http://www.cs.put.poznan.pl/ csobaniec/latex/. Klasa ta wymaga dodatkowego pliku dcslib.sty z uzupeniajcymi komendami. Klasa dcsbook moe by wykorzystana w programie LYX poprzez zainstalowanie dodatkowego pliku konguracyjnego dcsbook.layout (rwnie dostpnego na wspomnianej A stronie). Pliki *.cls i *.sty powinny by widziane przez system L TEX (mona do tego celu wykorzysta zmienn rodowiskow TEXINPUTS). Pliki *.layout powinny znale si w katalogu layouts w instalacji edytora LYX (katalog globalny lub prywatne ustawienia uytkownika). W klasie dcsbook zdeniowano kilka opcji, ktre okrelaj charakter pisanego dokumentu:

thesis textbook report

styl dla pisania prac inynierskich i magisterskich, styl dla pisania skryptw, styl dla pisania raportw instytutowych.

Piszc prac inyniersk lub magistersk naley rozpocz tekst od:

\documentclass[thesis]{dcsbook}

Oto pozostae opcje klasy dcsbook:

bw dcstoc

wersja czarno-biaa dokumentu zacza zmodykowany styl prezentowania spisu treci

Przykad 1 prezentuje przykadowy dokument korzystajcy z klasy dcsbook.

5.2 OpenOce / Microsoft Word

Do pisania pracy mona uy zaawansowanego edytora tekstowego typu OpenOce lub Microsoft Word. Naley jednak uwzgldni ponisze uwagi: Formatowanie tekstu naley wykona z wykorzystaniem styli. Uatwi to zarzdzanie dokumentem i uwzgldnienie uwag promotora odnonie formatowania (zmiana rozmiaru, kroju czcionki, odstpw itp.). Dokument naley zapisywa w formacie Open Document Format (rozszerzenie odt w przypadku dokumentw tekstowych), ktry jest obecnie standardem ISO. Piszc tekst w edytorze Word mona zastosowa wtyczk rmy Sun, ktra czyni obsug formatu ODF cakowicie transparentn. Wtyczk mona pobra ze strony http://www.sun. com/software/star/odf_plugin/. 6

Przykad 1: Szablon dokumentu pracy magisterskiej w LaTeX-u

\documentclass[12pt,a4paper,polish,thesis]{dcsbook} \usepackage[T1]{fontenc} \usepackage[utf8]{inputenc} \usepackage{babel} \setcounter{secnumdepth}{3} \setcounter{tocdepth}{3} \begin{document} \author{Jan Kowalski} \title{Tytu pracy} \supervisor{dr hab.~Stefan Nowak} \date{Pozna, 2011} n \maketitle \frontmatter \tableofcontents{} \mainmatter \chapter{Wstp} e Wprowadzenie do tematu... \section*{Cel i zakres pracy} Celem niniejszej pracy jest... \chapter{Podstawy teoretyczne} Wicej informacji mona znalec w ksiace \cite{sop}. e z z z \chapter{Projekt systemu} \chapter{Implementacja systemu} \chapter{Testy efektywnociowe} s \chapter{Zakoczenie} n \appendix \chapter{Przewodnik uytkownika} z \backmatter \begin{thebibliography}{1} \bibitem{sop}A.~Tanenbaum. \emph{Operating Systems Design and Implementation}. Prentice Hall, 2006. \end{thebibliography} \end{document}

6 Sowniczek ortograczny ;-)

Warto przeczyta jak pisa i odmienia takie trudne sowa jak np. Linux: http://thecamels.
org/2008/01/15/odmiana-slowa-linux-w-jezyku-polskim/.

klient obiekt danie

a nie klijent a nie objekt a nie rzdanie