Ogólne zasady pisania dokumentów technicznych na przykładzie

Strona tytułowa jest standardowa i dostępna na:
http://www.eka.pwr.wroc.pl/dyplomanci,41.dhtml
Streszczenie
Streszczenie
1. W pracach dyplomowych Politechniki Wrocławskiej element raczej nie stosowany (podobnie
jak słowa kluczowe), ale wymagany w większości publikacji naukowych.
2. Zawartość – zwięzły opis treści pracy.
3. Objętość najczęściej określona przez wydawcę (typowo 150 – 200 słów).
Paweł Dziechciński, Ogólne zasady pisania dokumentów technicznych na przykładzie pracy
dyplomowej
str. 2 z 10
Spis treści
Spis treści
1. Wstęp ...................................................................................................................................................... 4
2. Wprowadzenie ........................................................................................................................................ 5
3. Metodologia ............................................................................................................................................ 6
4. Wyniki badań i ich analiza oraz dyskusja ................................................................................................ 7
5. Podsumowanie ....................................................................................................................................... 8
Literatura .................................................................................................................................................... 9
Dodatek A. Uwagi ..................................................................................................................................... 10
Paweł Dziechciński, Ogólne zasady pisania dokumentów technicznych na przykładzie pracy
dyplomowej
str. 3 z 10
1. Wstęp
1. Wstęp
1. Objętość - typowo 1 lub 2 strony.
2. Zawartość:
a) nawiązanie do tematyki pracy – na przykład:
 rys historyczny,
 co skłoniło autora do zajęcia się tematem,
b) cel i zakres pracy,
c) często rozwinięcie tematu pracy,
d) jeśli opisanie celu i zakresu pracy wymaga poprzedzenia wprowadzeniem teoretycznym to
może być przedstawiony w dalszej części pracy,
e) omówienie zawartości pracy (np. rozdział po rozdziale).
Paweł Dziechciński, Ogólne zasady pisania dokumentów technicznych na przykładzie pracy
dyplomowej
str. 4 z 10
2. Wprowadzenie
2. Wprowadzenie
1. Objętość
a) odpowiednia do zakresu pracy,
b) nie należy chwalić się swoją wiedzą, a dostosować podane informacje do zakresu pracy
(dotyczy całej pracy).
2. Zawartość:
a) ogólne postawy teoretyczne,
b) przegląd literatury.
Paweł Dziechciński, Ogólne zasady pisania dokumentów technicznych na przykładzie pracy
dyplomowej
str. 5 z 10
3. Metodologia
3. Metodologia
1.
2.
Omówienie metod i wykorzystywanych narzędzi.
Procedury pomiarowe omówione na poziomie umożliwiającym powtórzenie badań
i zweryfikowanie wyników.
Paweł Dziechciński, Ogólne zasady pisania dokumentów technicznych na przykładzie pracy
dyplomowej
str. 6 z 10
4. Wyniki badań i ich analiza oraz dyskusja
4. Wyniki badań i ich analiza oraz dyskusja
1. Przedstawienie najważniejszych wyników.
2. Uwagi:
a) pracę powinno dać się czytać,
b) umieszczanie w treści rozbudowanych tabel czy złożonych schematów jest niewskazane,
c) szczegółowe wyniki zamieszcza się w dodatkach, a w treści pracy się do nich odwołuje.
3. Analiza i dyskusja wyników (może stanowić odrębne rozdziały).
Paweł Dziechciński, Ogólne zasady pisania dokumentów technicznych na przykładzie pracy
dyplomowej
str. 7 z 10
5. Podsumowanie
5. Podsumowanie
1. Uogólniona wersja uzyskanych wyników i ich dyskusji.
2. Konieczne jest zapewnienie zgodności z celami pracy.
3. Perspektywy dalszych badań.
Paweł Dziechciński, Ogólne zasady pisania dokumentów technicznych na przykładzie pracy
dyplomowej
str. 8 z 10
Literatura
Literatura
Przykładowy spis literatury:
1. Dobrucki A., Przetworniki elektroakustyczne, Warszawa: WNT 2006, ISBN 83-204-3214-6.
2. Dobrucki A.B., Measurement system for personalized head-related 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.
3. Smith S.W., The Scientist and Engineer's Guide to Digital Signal Processing,
[dostęp: 07.11.2012] http://www.dspguide.com/pdfbook.htm.
1. 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.
2. Normy dopuszczają kilka wariantów, ale należy stosować te same reguły dla całego spisu.
3. Proponowany format pozycji w spisie literatury dla książki:
[Autor], [Tytuł], [Wydanie], [Miejsce]: [Wydawca] [Rok], [ISBN].
a.
b.
c.
d.
[Autor] = [Nazwisko] [Inicjały].
[Inicjały] podajemy bez spacji np. Kowalski J.Z.
w przypadku kilku autorów pola [Autor] oddzielamy przecinkiem.
Przykładem może być książka profesora Dobruckiego [1] z zamieszczonego
przykładowego spisu literatury.
e. Przykład w wersji często stosowanej ale niezgodnej z normą:
Dobrucki A., Przetworniki elektroakustyczne, WNT, Warszawa 2006.
4. Proponowany format pozycji w spisie literatury dla artykułu z czasopisma lub wydawnictwa
zwartego podobny jak dla książki, ale:
a. [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.,
b. Często podaje się numery stron.
c. Nie stosuje się ISBN ani ISSN bo dotyczą całego wydawnictwa a nie pojedynczego
artykułu.
d. Przykładem może być artykuł profesora Dobruckiego [2] z zamieszczonego
przykładowego spisu literatury.
5. Proponowany format pozycji w spisie literatury dla dokumentu elektronicznego z www na
przykładzie książki Smitha [3] z zamieszczonego przykładowego spisu literatury.
Paweł Dziechciński, Ogólne zasady pisania dokumentów technicznych na przykładzie pracy
dyplomowej
str. 9 z 10
Dodatek A. Uwagi
Dodatek A. Uwagi
1. Uwagi do układu pracy:
a) tytuły rozdziałów nie muszą być zgodne z podanymi tytułami,
b) kolejność pisania rozdziałów najczęściej nie jest zgodna z ich kolejnością w pracy,
c) liczba numerowanych poziomów podrozdziałów raczej nie większa niż 3,
d) rozdział najczęściej zaczyna się od nowej strony.
2. Do każdego rysunku i tabeli powinno być odwołanie w tekście.
a. Przykład: „Schemat blokowy systemu nagłaśniania przedstawiono na rys. 7.”
b. Można stosować odwołania jako wtrącenia w nawiasach – np. „Uzyskana w wyniku
pomiarów charakterystyka częstotliwościowa (rys. 7) jest …”.
c. Nie należy stosować odsyłaczy typu „powyżej” czy ”poniżej”.
3. Zasady stosowania podpisów.
a. Lokalizacja podpisu:
 pod rysunkiem,
 nad tabelą.
b. Każdy rysunek i każda tabela muszą mieć podpis zawierający:
 etykietę (typowo: rys., tabela),
 numer,
o 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).
c. 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
d. Uwagi:
 po numerze należy stosować kropkę,
 spotyka się wersję z kropką po tytule.
Pozostałe uwagi przedstawiono w prezentacji.
Paweł Dziechciński, Ogólne zasady pisania dokumentów technicznych na przykładzie pracy
dyplomowej
str. 10 z 10