poradnik_jak pisac mgr_1.pdf

Jakpisa¢prac¦in»yniersk¡/magistersk¡

CezarySobaniec

v1.5, 2007/12/18

Streszczenie

Niniejszy poradnik ma by¢ pomoc¡ dla studentów w pisaniu pracy in»ynierskiej i

pó¹niej magisterskiej a z drugiej strony ma pomóc promotorom ograniczaj¡c ich prac¦ do

korekty merytorycznej a nie redakcyjnej, która mo»e by¢ wykonana samodzielnie przez

studenta. Przedstawione zasady i porady s¡ ogólne i mo»na je stosowa¢ zarówno w

przypadku stosowania edytorów tekstowych (OpenOce, MS Word) jak i systemu L A T E X.

Poradnik powstał m.in. w oparciu o materiały przygotowane przez Macieja Drozdow-

skiego i dost¦pne pod adresem http://www.cs.put.poznan.pl/mdrozdowski/dyd/txt/

jak_mgr.html .

Spis tresci

1 Wst¦p

2 Struktura pracy

3 Styl

4 Skład tekstu 3

4.1 Czcionka i akapity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

4.2 Układ strony . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

4.3 Dywiz, my±lnik i pauza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

4.4 Podział słów . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

4.5 Odst¦py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4.6 Rozdziały i podrozdziały . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4.7 Rysunki i tabele . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4.8 Literatura . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

4.9 Korekta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

5 Narz¦dzia 6

5.1 L A T E X / L Y X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

5.2 OpenOce / Microsoft Word . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

6 Słowniczek ortograﬁczny ;-)

1 Wst ep

Zaraz na wst¦pie chciałbym podkre±li¢ co±, co jak okazuje si¦ nie dla wszystkich studentów

jest całkowicie oczywiste. Chodzi o wykorzystanie do pisania swojej pracy magisterskiej ze-

wn¦trznych materiałów ¹ródłowych. Całkowicie naturalnym i cz¦sto wr¦cz po»¡danym jest

powoływanie si¦ na materiały ¹ródłowe: ksi¡»ki, artykuły w czasopismach, dokumentacj¦

techniczn¡, czy w wreszcie na wszelkie inne publikacje dost¦pne w Internecie. Odwołanie do

takich materiałów stanowi wsparcie dla tez, które chcemy przekaza¢ czy udowodni¢. Odwo-

łanie mo»e mie¢ form¦ wskazania na materiał ¹ródłowy, zawieraj¡ce nazwisko autora, tytuł i

miejsce publikacji oraz dat¦ wydania. Odwołanie mo»e równie» mie¢ form¦ cytatu, jednak»e

z wyra¹nym zaznaczeniem cytowanego fragmentu oraz ze wskazaniem na ¹ródło. Całkowicie

jednak niedopuszczalne jest kopiowanie do pracy fragmentów tekstów, których nie jeste±my

autorami. Takie post¦powanie to plagiat !

2 Struktura pracy

Praca in»ynierska/magisterska powinna mie¢ nast¦puj¡c¡ struktur¦:

1. Strona tytułowa.

2. Karta pracy z podpisem dziekana.

3. Spis tre±ci.

4. Wst¦p z podpunktem opisuj¡cym cel i zakres pracy.

5. Rozdział(y) „teoretyczny” deﬁniuj¡cy(e) rozwa»ane zagadnienie i opisuj¡cy aktualny

stan wiedzy (np. modele matematyczne i wzory, opis stanu rzeczywisto±ci, procedur

biznesowych itp.).

6. Rozdział(y) opisuj¡cy(e) na wysokim poziomie abstrakcji ide¦/sposób/metod¦ rozwi¡-

zania postawionego problemu (np. model powi¡za« mi¦dzy danymi, struktura bazy

danych, szczegółowa specyﬁkacja wymaga«, diagramy u»ycia, itp.).

7. Rozdział(y) opisuj¡cy(e) techniczn¡ stron¦ rozwi¡zania (dokumentacja techniczna, istotne

wyj¡tki z kodu ¹ródłowego programów).

8. Rozdział(y) opisuj¡cy(e) przeprowadzone testy jednostkowe/integracyjne/funkcjonalne-

/akceptacyjne/efektywno±ciowe, oraz innego rodzaju uzyskane wyniki wraz z ich ana-

liz¡.

9. Zako«czenie zawieraj¡ce podsumowanie i wnioski.

10. Literatura.

11. Zał¡czniki.

Do pracy nale»y zał¡czy¢ dysk CD/DVD ułatwiaj¡cy kontynuowanie pracy przez ko-

lejnych studentów. Dysk taki powinien zawiera¢:

• pełen tekst pracy (np. w formacie PDF),

• informacje o autorach wraz z adresem kontaktowym (nr telefonu, email),

• kompletne kody ¹ródłowe opracowanej aplikacji wraz z (ewentualnym) repozyto-

rium systemu zarz¡dzania wersjami (np. CVS lub Subversion),

• pliki konﬁguracyjne,

• kopi¦ ogólnodost¦pnej dokumentacji w wersji elektronicznej.

3 Styl

1. Zamiast I osoby liczby pojedynczej (np. (ja) zrobiłem, (ja) zaprojektowałem, (ja) zapro-

gramowałem, (ja) przetestowałem) przyj¦ło si¦ u»ywa¢ formy bezosobowej (zrobiono,

zaprojektowano, zaprogramowano, przetestowano) lub I osoby liczby mnogiej (zrobili-

±my, zaprojektowali±my, zaprogramowali±my, przetestowali±my). Wydaje si¦, »e najod-

powiedniejsza jest forma bezosobowa.

2. Praca powinna da¢ si¦ normalnie czyta¢ tak jak esej lub wypracowanie. Nie powinna

by¢, np., zbiorem list wypunktowuj¡cych ró»ne zagadnienia.

3. Pisz¡c prac¦ z informatyki, nale»y u»ywa¢ terminologii informatycznej, która ma spre-

cyzowan¡ tre±¢ i znaczenie. Nie powinno si¦ u»ywa¢ gazetowych okre±le« typu: silnik

programu, maszyna skryptowa, elektroniczny mechanizm, gdy» nie wiadomo co one

wła±ciwie oznaczaj¡.

4. Nale»y unika¢ „eleganckiego” stylu, gdy» najcz¦±ciej wychodzi styl „bombastyczny”.

Np.: „jeden z najznamienitszych przykładów”, „program niesamowicie prosty w obsłu-

dze”, „proces jest niezwykle trywialny”, „celem znakomitej wi¦kszo±ci”.

5. Nale»y unika¢ przesadnie długich zda«.

6. Zdecydowanie nale»y unika¢ tworzenia nowych słów i u»ywania »argonu. Lepszym

rozwi¡zaniem jest u»ycie bardziej opisowego stylu. Je±li z jaki± powodów stosujemy

nowe poj¦cie/zwrot, to koniecznie nale»y je wyja±ni¢ przy pierwszym u»yciu.

7. Mała klarowno±¢ tekstu i słaba gramatyka s¡ przejawami niezrozumienia tematu. Je-

»eli czytelnik ma problem ze zrozumieniem, to z du»ym prawdopodobie«stwem mo»na

powiedzie¢, »e autor nie wie co chce powiedzie¢.

8. Przygotowanie dobrej dokumentacji wymaga czasu. Mo»na przyj¡¢, »e 1 strona A4

dobrej dokumentacji wymaga 1 dnia pracy.

9. Przypisy. Nale»y unika¢ stosowania przypisów. Przypis powinien mie¢ charakter uzu-

pełniaj¡cego tekstu, który dodatkowo jest wtr¡ceniem pochodz¡cym z innego kontekstu.

W przypisie nie mo»na zawiera¢ istotnych tre±ci z punktu widzenia celu pracy.

4 Skład tekstu

4.1 Czcionka i akapity

1. Nale»y u»y¢ czcionki szeryfowej (typu Times lub ComputerModern ) o wielko±ci od 10

do 13.

2. Przykłady kodów ¹ródłowych powinny by¢ drukowane czcionk¡ o stałej szeroko±ci

(np. Courier ).

3. Interlinia nie powinna by¢ wi¦ksza od 1,5.

4. Główny tekst pracy powinien by¢ wyjustowany (wyrównany do lewej i prawej).

4.2 Układ strony

1. Marginesy poziome powinny by¢ z zakresu 2 do 3 cm, pionowe nieco wi¦ksze. Wskazane

jest ustawienie niesymetrycznych marginesów, tak aby po zszyciu pracy mo»liwe było

odczytanie tekstu blisko oprawy.

2. Strony powinny by¢ ponumerowane. Warto doda¢ do dokumentu »yw¡ pagin¦ (nagłó-

wek dla ka»dej strony), która b¦dzie zawiera¢ tytuł pracy lub (lepiej) tytuł rozdziału

wraz z numerem strony.

4.3 Dywiz, myslnik i pauza

Opis

Przykład Zapis w L A T E X-u

Dywiz krótka kreseczka u»ywana do przenoszenia

wyrazów i zapisu zbitek typu biało-czarni

biało-czarny

My±lnik u»ywany jest do zapisu zakresu warto±ci

10–20

Pauza najpopularniejszy „my±lnik” słu»¡cy do

oddzielania cz¦±ci zdania

on — ona

---

Wokół pauzy powinny by¢ wstawiane odst¦py, np.:

Pauza --- szczególnie w jezyku polskim --- pełni role...

W przypadku edytorów tekstowych warto zdeﬁniowa¢ reguł¦ autokorekty dokonuj¡cej za-

miany -- i --- na odpowiednie znaki specjalne – i —.

4.4 Podział słów

1. Koniecznie nale»y wł¡czy¢ automatyczne przenoszenie wyrazów. L A T E X domy±lnie dzieli

słowa. Edytory tekstowe wymagaj¡ jawnego wł¡czenia tej opcji.

2. Nale»y unika¢ pozostawiania pojedynczych liter na pocz¡tku i ko«cu zdania. Je»eli

zdanie zaczyna si¦ od spójnika „z”, „w”, „i”, to po spójniku nale»y wstawi¢ niepodzielny

odst¦p. W przypadku L A T E X-a jest to komenda ~ , a w przypadku edytorów b¦dzie to

kombinacja Ctrl-Spacja . Przykład:

W~przypadku \LaTeX-a jest to komenda...

4.5 Odst epy

1. Nie powinno by¢ dodatkowego odst¦pu przed kropk¡ ko«cz¡c¡ zdanie, np.:

Zdanie to jest zapisane niepoprawnie .

2. Tekst w nawiasach powinien by¢ zapisany bez dodatkowych odst¦pów, np.:

Przykładowy przebieg (Rysunek 1.5) prezentuje...

3. Je»eli w zdaniu pojawia si¦ skrót z kropk¡, to nale»y skasowa¢ (w przypadku L A T E X-a)

dodatkowy odst¦p komend¡ \ , np.:

Pan inz.\ Kowalski jest dobrym specjalist a.

4. Dodatkowy odst¦p po kropce nie jest dodawany, gdy przed kropk¡ wyst¦puje du»a

litera. W takim przypadku nale»y go wymusi¢ komend¡ \@ 1 , np.:

Przygotowalismy wniosek do KBN\@. Wniosek jest...

4.6 Rozdziały i podrozdziały

1. Tytuły rozdziałów i podrozdziałów powinny by¢ zapisywane bez znaków interpunkcyj-

nych (kropka lub dwukropek na ko«cu).

2. Rozdziały i podrozdziały powinny by¢ numerowane w sposób hierarchiczny. Do spisu

tre±ci powinny traﬁ¢ punkty o maksymalnie trzecim poziomie zagnie»d»enia, czyli np. 2.1.5.

3. Rozdziały powinny rozpoczyna¢ si¦ od nowej strony, na wydruku dwustronnym od

strony nieparzystej. Pozostała tre±¢ pracy powinna by¢ pisana jednym ci¡giem.

4. Nale»y unika¢ wydzielania pojedynczych podrozdziałów z rozdziałów, np. rozdział 3

z jedynym podrozdziałem 3.1. W takiej sytuacji nale»y zrezygnowa¢ z wydzielania

podrozdziału lub z jego numerowania.

4.7 Rysunki i tabele

1. Rysunki i tabele powinny mie¢ podpisy ł¡cznie z numerem kolejnym, np. Rys.3.7 . Pod-

pis dla rysunku nale»y umie±ci¢ pod rysunkiem, podpis dla tabeli powinien znajdowa¢

si¦ nad tabel¡.

2. Nale»y unika¢ stosowania graﬁki rastrowej (np. formaty GIF, PNG, JPEG) zast¦puj¡c

j¡ graﬁk¡ wektorow¡ (np. formaty Postscript, PDF). W przypadku graﬁki rastrowej

nale»y zastosowa¢ odpowiednio du»¡ rozdzielczo±¢ (150–300dpi).

1 Komend¦t¡mo»nauzyska¢wL Y X-ieu»ywaj¡ckombinacjiCtrl-.

Plik z chomika:

Inne pliki z tego folderu:

Inne foldery tego chomika: