Układ pracy

Seminarium dyplomowe
Paweł Dziechciński C5 p.508A
[email protected]
Konsultacje: wtorek 730-930, środa 1115-1315
Zasady pisania prac
dyplomowych
Wstęp
• Moje motywy:
– pomoc dla studentów przy pisaniu dokumentów
technicznych (nie tylko prac dyplomowych),
– pomoc dla promotorów (oszczędność czasu),
– działanie zapobiegawcze związane z błędami
pojawiającymi się w wielu pracach dyplomowych.
Uwagi
1. Część podanych informacji jest subiektywną opinią autora,
a niniejsza prezentacja nie jest opracowaniem uniwersalnym.
a. Promotorzy mogą mieć inne wymagania.
b. Podane zasady w znacznym zakresie dotyczą również innych
dokumentów technicznych, ale zwłaszcza ich układ może się
różnić.
c. Praca inżynierska nie jest typowym projektem technicznym, ale
projekt może być jej częścią.
2. Autor począwszy od szkoły średniej uczęszczał wyłącznie do szkół
technicznych w związku z czym nie uważa się za profesjonalistę
w zakresie znajomości gramatyki i ortografii.
3. Podane treści bez komentarza słownego mogą być niewłaściwie
interpretowane.
4. Nie wszystkie podane zasady muszą być stosowane w prezentacjach.
Układ pracy
• Strona tytułowa
– zestandaryzowana,
– dostępna na:
http://www.eka.pwr.wroc.pl/dyplomanci,41.dhtml
• Streszczenie
–
–
–
w pracach dyplomowych Politechniki Wrocławskiej element
raczej nie stosowany (podobnie jak słowa kluczowe), ale
wymagany w większości publikacji naukowych;
zawartość – zwięzły opis treści pracy;
objętość najczęściej określona przez wydawcę (typowo 150 –
200 słów).
• Spis treści
Układ pracy
1. Wstęp
–
–
objętość - typowo 1 lub 2 strony,
zawartość:
•
nawiązanie do tematyki pracy – na przykład:
–
–
•
cel i zakres pracy
–
–
•
rys historyczny,
co skłoniło autora do zajęcia się tematem,
często rozwinięcie tematu pracy,
jeśli opisanie celu i zakresu pracy wymaga poprzedzenia
wprowadzeniem teoretycznym to może być przedstawiony w dalszej
części pracy,
omówienie zawartości pracy (np. rozdział po rozdziale).
Układ pracy
2. Wprowadzenie
–
Objętość
•
•
–
odpowiednia do zakresu pracy,
nie należy chwalić się swoją wiedzą, a dostosować podane
informacje do zakresu pracy (dotyczy całej pracy).
Zawartość
•
•
ogólne postawy teoretyczne;
przegląd literatury.
Układ pracy
3. Metodologia
–
–
Omówienie metod i wykorzystywanych narzędzi;
Procedury pomiarowe omówione na poziomie
umożliwiającym powtórzenie badań i zweryfikowanie
wyników.
Układ pracy
4. Wyniki badań i ich analiza oraz dyskusja
–
Przedstawienie najważniejszych wyników
•
•
•
–
pracę powinno dać się czytać;
umieszczanie w treści np. rozbudowanych tabel czy
złożonych schematów jest niewskazane;
szczegółowe wyniki zamieszcza się w dodatkach, a w treści
pracy się do nich odwołuje.
Analiza i dyskusja wyników
•
mogą stanowić odrębne rozdziały.
Układ pracy
5. Podsumowanie
– Uogólniona wersja uzyskanych wyników i ich dyskusji
– Konieczne jest zapewnienie zgodności z celami pracy
– Perspektywy dalszych badań.
Układ pracy
Uwagi do układu pracy:
– tytuły rozdziałów nie muszą być zgodne z tytułami
podanymi powyżej,
– kolejność pisania rozdziałów najczęściej nie jest
zgodna z ich kolejnością w pracy,
– liczba numerowanych poziomów podrozdziałów raczej
nie większa niż 3,
– rozdział najczęściej zaczyna się od nowej strony.
Uwagi edycyjne
• Do każdego rysunku i tabeli powinno być
odwołanie w tekście
– np. „Schemat blokowy systemu nagłaśniania
przedstawiono na rys. 7.”
– można stosować odwołania jako wtrącenia w
nawiasach – np. „Uzyskana w wyniku pomiarów
charakterystyka częstotliwościowa (rys. 7) jest …”
– nie należy stosować odsyłaczy typu „powyżej” czy
”poniżej”.
Podpisy
• Zasady:
– Lokalizacja podpisu:
• pod rysunkiem,
• nad tabelą.
– Każdy rysunek i każda tabela muszą mieć podpis
zawierający:
• etykietę (typowo: rys., tabela),
• numer,
– numeracja może być ciągła,
– kolejny numer w rozdziale może zostać poprzedzony numerem
rozdziału, w którym znajduje się rysunek,
• tytuł,
• pochodzenie (w przypadku kiedy nie są dziełem autora).
Podpisy
• Przykłady:
– Rys. 11. Tytuł jedenastego rysunku w pracy
– Rys. 4.3. Tytuł trzeciego rysunku w rozdziale
czwartym
– Tabela 11. Tytuł jedenastej tabeli w pracy
– Tabela 4.3. Tytuł trzeciej tabeli w rozdziale czwartym
• Uwagi!
– Po numerze należy stosować kropkę
– Spotyka się wersję z kropką po tytule
Korzystanie z możliwości edytorów
tekstu
• Rozdziały i podrozdziały należy oznaczać jako
nagłówki
• Do podpisów należy stosować odpowiednie style
• Automatyczne odsyłacze do literatury, rysunków
i tabel
• Sprawdzanie pisowni - ostrożnie.
Styl pisania
• Pracę należy pisać:
– zgodnie z ogólnymi zasadami ortografii i gramatyki
języka, w którym jest pisana,
– zrozumiale,
– zwięźle,
– prosto (ale nie za prosto),
– stosując krótkie zdania,
– bezosobowo (np. „napotkano trudności”) lub stosować
trzecią osobę liczby pojedynczej (np. „autor napotkał
trudności”).
Wyliczanie
• Podpunkty będące zdaniami powinny się zaczynać wielką literą,
a nie będące zdaniami małą.
• Jeśli podpunkt jest zdaniem, to zamykamy go kropką lub znakiem
równoważnym, jeśli nie – przecinkiem lub średnikiem. Średnikiem,
przede wszystkim wtedy, gdy podpunkty są dłuższe i same zawierają
przecinki.
• W spisach treści, reklamach, na plakatach itp. – wszędzie tam, gdzie
układ graficzny liczy się nie mniej od treści – podpunktów nie
zamykamy żadnym znakiem interpunkcyjnym, gdyż sam koniec
wiersza wystarcza.
• Nagłówek listy powinien się kończyć dwukropkiem, nawet wtedy,
gdy następujące po nim podpunkty zdaniowe, pisane są wielką
literą.
• Jeśli np. nagłówek listy jest zarazem podrozdziałem książki lub
artykułu, to nie zamykamy go żadnym znakiem przestankowym.
Wyliczanie
• Oznaczanie cyframi lub literami kolejnych punktów wyliczenia
pozwala precyzyjnie odsyłać czytelnika do konkretnych punktów.
• Zasady:
1. Po oznaczeniach zakończonych kropką podpunkt zaczynamy
z dużej litery i kończymy kropką.
2. Po oznaczeniach zakończonych nawiasem podpunkt zaczynamy
z małej litery i kończymy przecinkiem lub średnikiem, poza
ostatnim elementem, który kończymy kropką.
Odsyłacze literaturowe
• Nie stosować przypisów dolnych, a odsyłacz do
spisu literatury znajdującego się na końcu pracy
• Odsyłacz literaturowy ma być stosowany na
zasadzie wtrącenia - nie może być częścią zdania
Spis literatury
• Spis literatury zamieszcza się na oddzielnej stronie, na
końcu pracy, ale przed załącznikami
• Typowo rozpoczynamy go nagłówkiem „Literatura” (bez
cudzysłowu)
• Kolejność - dwie wersje:
– alfabetycznie według nazwiska autora (dla prac tego
samego autora według tytułów),
– zgodnie z kolejnością powoływania w tekście.
Spis literatury
• Zasady podane w normach:
– PN-ISO 690:2002. Dokumentacja - Przypisy
bibliograficzne - Zawartość, forma i struktura.
– PN – ISO 690-2:1999. Informacja i dokumentacja –
przypisy bibliograficzne – Arkusz 2:Dokumenty
elektroniczne i ich części.
• Normy dopuszczają kilka wariantów, ale należy
stosować te same reguły dla całego spisu
Proponowany format pozycji w spisie
literatury - książka
• [Autor], [Tytuł], [Wydanie], [Miejsce]:
[Wydawca] [Rok], [ISBN].
–
[Autor] = [Nazwisko] [Inicjały]
•
•
[Inicjały] podajemy bez spacji np. Kowalski J.Z.
w przypadku kilku autorów pola [Autor] oddzielamy
przecinkiem.
Proponowany format pozycji w spisie
literatury - książka
• Przykład:
1. Dobrucki A., Przetworniki elektroakustyczne,
Warszawa: WNT 2006, ISBN 83-204-3214-6.
• Przykład w wersji często stosowanej ale
niezgodnej z normą:
1. Dobrucki A., Przetworniki elektroakustyczne, WNT,
Warszawa 2006.
Proponowany format pozycji w spisie literatury –
artykuł z czasopisma lub wydawnictwa zwartego
• Ogólne zasady jak dla książki, ale:
–
–
–
[Wydawnictwo] w przypadku czasopism posiada ściśle określony
opis (często skrót), który najczęściej można znaleźć w stopce –
np. J. Audio Eng. Soc.,
często podaje się numery stron,
nie stosuje się ISBN ani ISSN bo dotyczą całego wydawnictwa a
nie pojedynczego artykułu.
• Przykład:
1.
Dobrucki A.B., Measurement system for personalized headrelated transfer functions and its verification by virtual source
localization trials with visually impaired and sighted
individuals, J. Audio Eng. Soc., vol. 58, nr 9, s. 724-738.
Proponowany format pozycji w spisie literatury –
dokument elektroniczny z www
• Przykład:
1. Smith S.W., The Scientist and Engineer's Guide to
Digital Signal Processing, [dostęp: 07.11.2012]
http://www.dspguide.com/pdfbook.htm
Inne zasady
1. Nie stosuje się spacji:
–
–
przed kropką, przecinkiem, średnikiem,
dwukropkiem,
wewnątrz nawiasów lub cudzysłowów.
2. Spację stosuje się po kropce, przecinku,
średniku, dwukropku, chyba, że znaki te pełnią
funkcję specjalną (np. godzina 12:28).
3. Myślnik stosuje się:
– ze spacjami przed i po, jeśli rozdziela dwie części
zdania,
– bez spacji jeśli łączy dwa wyrazy (np. żółto-niebieski).