Wymagania dotyczące dokumentacji projektu inżynierskiego

2013-10-20
Części dokumentacji
strony tytułowe (wzór dostępny na stronie
internetowej Wydziału, sekcja Studia->Dokumenty)
oświadczenie o samodzielnym wykonaniu projektu
Wymagania dotyczące
dokumentacji projektu
inżynierskiego
Małgorzata Jakubowska
opinia promotora i recenzja
ew. podziękowania
spis treści
wstęp wraz z określonym wyraźnie celem pracy
rozdziały…
podsumowanie i wnioski
Katedra Chemii Analitycznej
Wydział Inżynierii Materiałowej i Ceramiki AGH
Spis treści
umieszczamy po stronach tytułowych
zawiera informację o wszystkich składowych pracy
wraz z numerami stron
•
•
•
•
•
•
•
wstęp
tytuły rozdziałów i podrozdziałów
literatura
ewentualnie spis skrótów stosowanych w pracy
ewentualnie spis tabel
ewentualnie spis rysunków
ewentualnie załączniki
spis treści musi być kompletny
Rozdziały
rozdział – podstawowy element składowy pracy
układ rozdziałów powinien być przejrzysty, logicznie
spójny i bez powtórzeń
rozdziały mogą mieć podrozdziały (jeżeli
wykorzystuje się taką strukturę dokumentu, to
rozdział powinien mieć przynajmniej dwa
podrozdziały)
w strukturze rozdziałów należy uwzględnić podział
na:
•
•
•
•
spis źródeł literaturowych, stron internetowych i
dokumentów (np. norm, ustaw), wykorzystanych w
pracy
Wstęp
określenie dziedziny wiedzy, jakiej dotyczy praca
wskazanie istotności zagadnień podanych w tytule
pracy
określenie i wyjaśnienie celu pracy (wskazane
użycie sformułowania: „Celem pracy jest/było ….”)
krótki opis metod, jakie stosowano
krótka (kilka zdań) charakterystyka treści
zawartych w poszczególnych rozdziałach
odzwierciedlająca metodologię i etapy realizacji
projektu (przykładowe sformułowania: „W rozdziale
pierwszym omówiono/przedstawiono…”, „Rozdział
drugi dotyczy…”)
Podsumowanie pracy
odzwierciedla metodologię prowadzonych działań i
uzyskane efekty
jest ściśle powiązane ze wstępem oraz kolejnymi
rozdziałami
prezentuje krótki opis końcowych efektów pracy z
podaniem konkretnych ustaleń
zawiera stwierdzenie czy cel pracy został osiągnięty
ewentualnie sugeruje dalsze kroki badań lub inne
warianty rozwiązania problemu
wstęp
część literaturowa
część projektowa
podsumowanie i wnioski
1
2013-10-20
Wskazówki edycyjne
rozmiar strony: A4
marginesy strony: lewy margines 3 cm, pozostałe
marginesy 2 cm
krój czcionki: Times New Roman
wielkość czcionki tekstu podstawowego: 12 pkt.
wielkość czcionki przypisów, nagłówków tabel i
podpisów pod rysunkami: 10 pkt.
interlinia: 1.5
styl akapitowy (tzn. wcięcie przed każdym akapitem,
tekst ciągły)
Listy wypunktowane i numerowane
każda lista powinna być poprzedzona tekstem
wprowadzającym
jednolita forma graficzna (znak wiodący, wcięcie,
odstęp od znaku wiodącego)
Objętość pracy:
nie mniej niż 30 stron
chyba nie więcej niż 60-70 stron
Tabele
tabele numerujemy liczbami arabskimi według
kolejności występowania – jednolicie w całej pracy
(ew. w rozdziałach)
tytuł tabeli, poprzedzony skrótem Tab. i kolejnym
numerem, powinien być umieszczony nad tabelą
jeżeli tabela zawiera informacje pochodzące ze
źródeł literaturowych, odwołanie należy umieścić
bezpośrednio w tytule tabeli (na końcu tytułu)
tabele należy umieścić w tekście wyśrodkowane
w nagłówkach kolumn tekst powinien być
pogrubiony i wyśrodkowany
w tekście należy umieścić odwołanie do każdej
tabeli
Wzory matematyczne
do formatowania wzorów należy używać edytora
równań
wzory numerujemy liczbami arabskimi według
kolejności występowania – jednolicie w całej pracy
(ew. w rozdziałach)
numery wzorów w nawiasach okrągłych powinny
być wyrównane do prawego marginesu
wzory należy umieścić w tekście wyśrodkowane
symbole zmiennych wykorzystywane w formule po
raz pierwszy powinny zostać objaśnione
bezpośrednio poniżej formuły
symbole zmiennych wykorzystywane w formule,
jeżeli występują w tekście, powinny być pisane
czcionka pochyloną (italic)
Rysunki, zdjęcia, schematy
rysunki numerujemy liczbami arabskimi według
kolejności występowania – jednolicie w całej pracy
(ew. w rozdziałach)
tytuł rysunku, poprzedzony skrótem Rys. i
kolejnym numerem, powinien być umieszczony pod
rysunkiem
jeżeli rysunek pochodzi ze źródeł literaturowych,
odwołanie należy umieścić bezpośrednio w tytule
rysunku (na końcu tytułu)
rysunki należy umieścić w tekście wyśrodkowane
w tekście należy umieścić odwołanie do każdego
rysunku
Spis literatury, stron internetowych i
wykorzystanych dokumentów
książka – autor/autorzy (inicjał imienia, kropka, nazwisko),
tytuł, wydawnictwo, miejsce i rok wydania
•
D. Stranneby, Cyfrowe przetwarzanie sygnałów,
Wydawnictwo BTC, Warszawa 2004
•
Instrumentalne metody analizy chemicznej, pod red. W.W.
Kubiaka, J. Gołasia, skrypt AGH, AKAPIT, Kraków 2005
rozdział książki – autor/autorzy rozdziału, tytuł rozdziału,
tekst: „w:”, dane o książce (j.w.)
•
P. D. Wentzell, Ch. D. Brown, Problemy interpretacji
wyników, w: R.A. Meyers, Encyklopedia chemii
analitycznej, John Wiley & Sons Ltd, Chichester 2000
normy – numer, tytuł
•
Norma PN-EN ISO/IEC 17025:2001, Ogólne wymagania
dotyczące laboratoriów badawczych i wzorcujących
akty prawne – numer, tytuł, pozycja w dzienniku ustaw
•
Rozporządzenie Ministra Zdrowia z dn. 4.06. 2003 r. pt.
„…”, DZ. U. Nr 116, poz:1103
2
2013-10-20
Spis literatury, stron internetowych i
wykorzystanych dokumentów
artykuł w czasopiśmie naukowym – autor/autorzy, tytuł artykułu,
tytuł czasopisma, nr wolumenu, rocznik, numer strony
początkowej artykułu
•
E. Richards, C. Bessant, S. Saini, Nowe czujniki
potencjometryczne, Analityka 14 (2002) 1533
artykuł w materiałach konferencji naukowej - autor/autorzy,
tytuł pracy, tytuł konferencji, miejsce, zakres dat, rok
konferencji, zakres stron
•
A. Kowalski, Zastosowanie mikroelektrody rtęciowej typu
CGMDE do wykrywania i oznaczania surfaktantów,
XLVIII Zjazd Naukowy PTChem, Poznań 18–22 września
2005, s.17-18.
publikacja elektroniczna – tytuł strony, adres URL, data
pozyskania informacji
•
Główny Urząd Miar, http://www.gum.gov.pl (odwiedzona
7.10.2010)
Terminologia
poprawne formułowanie myśli zależy m.in. od
jasności używanych pojęć
należy używać ścisłego języka inżynierskiego
pojęcia podstawowe należy wyczerpująco wyjaśnić,
podając je za literaturą
terminy nowe, proponowane przez piszącego pracę
trzeba dokładnie zdefiniować
należy objaśniać skróty przy pierwszym ich użyciu
Spis i odwołania literaturowe
jeżeli publikacja ma więcej niż sześciu autorów listę
należy skrócić stosując słowa et al. po szóstym
nazwisku
pozycje w spisie są uporządkowane według
kolejności ich występowania w tekście pracy
odwołanie zaznaczamy w tekście poprzez podanie w
nawiasach kwadratowych numeru pozycji w spisie
literatury (np. [5], [6,13], [11-14])
jeżeli odwołanie pojawia się na końcu zdania, to
umieszczamy je przed kropką.
Wymogi językowe
praca powinna być napisana krótko, zwięźle i być
pozbawiona niepotrzebnych, nic nie wnoszących
słów i zwrotów
należy zwrócić szczególną uwagę na reguły
ortograficzne i interpunkcyjne obowiązujące w
języku polskim
terminy podawane w języku angielskim powinny
zostać podane także w języku polskim (o ile to
możliwe)
Uwagi ogólne
tekst proszę redagować stosując styl bezosobowy
(np. zaobserwowano, zbadano itp.)
należy używać ścisłego języka technicznego i unikać
zwrotów potocznych i żargonu
po tytułach nie stawia się kropki (błąd
interpunkcyjny)
strony w pracy powinny być numerowane (liczby
arabskie)
skróty należy objaśnić przy pierwszym użyciu
nie należy stosować sformułowań „poniżej”,
„powyżej” ale wskazywać numery wzorów, tabel,
rysunków
listy wypunktowane – należy stosować ten sam
znak wiodący i wcięcie
Dziękuję za uwagę!
3