Zasadniczo w opisie pracy dyplomowej powinny się znaleźć 3 główne części:
- Co było do zrobienia? – wstęp, osadzenie w realiach, wprowadzenie informacji, z których korzystano itp. Np. w pracy pt. „Sterownik VGA z interfejsem magistrali AMBA” powinny się w tym miejscu znaleźć m.in. rozdziały: „Opis interfejsu VGA” oraz „Opis magistrali AMBA”.
- Jak to zrobiono?
a). dokumentacja konstrukcyjna, uwzględniająca architekturę, przyjęte rozwiązania sprzętowe i programowe, opis funkcji poszczególnych modułów itp.
b). dokumentacja użytkowa, zawierająca informacje o sposobie korzystania z efektów pracy (np.: mapy pamięci, nazwy i funkcje rejestrów sterujących, znaczenie poszczególnych bitów w rejestrach itp.)
c). z jakich narzędzi i w jaki sposób korzystano? (oprogramowanie CAD/CAE, przyrządy itp.) - Co z tego wynika? (szczególne „odkrycia” i ew. ciekawostki z toku realizacji pracy; wnioski; zakończenie).
Zalecenia edytorskie:
- Praca powinna zostać dostarczona w edytorze MS Word, aby możliwe było jej efektywne poprawianie (nanoszenie uwag i ich akceptacja). W przeciwnym przypadku praca zostanie jedynie oceniona, bez możliwości jej poprawienia.
- Nie należy stawiać kropek po tytułach rozdziałów, rysunków czy tabel.
- Nowy rozdział należy zaczynać od nowej strony.
- Każda zamieszczona grafika powinna mieć wskazane pochodzenie, w formie komentarza (preferowane: "Opracowanie własne.") albo z odnośnikiem do źródła w bibliografii.
- Każda pozycja wymieniona w bibliografii musi być jawnie (przez wstawienie odnośnika) użyta w tekście pracy.
- W bibliografii nie umieszcza się pozycji dotyczących informacji oczywistych, niespecyficznych dla pracy (np. twierdzenie Shannona, prawo Ohma itp.)
- Każdy odnośnik do informacji pobranej z internetu powinien, poza adresem URL, mieć datę pozyskania tej informacji.
- Użycie punktorów (bullet) lub numerowania przy wymienianiu dłuższej listy nie powoduje, że każdy z elementów staje się oddzielnym zdaniem. Każdy element po punktorze / numerze powinien więc z reguły zaczynać się małą literą, a kończyć przecinkiem, ostatni zaś — kończyć się kropką, tak jak ma to miejsce poniżej (pkt. 9 zaleceń językowo-stylistycznych).
- Słowa z języków obcych należy pisać kursywą (ang. italic).
- W Polsce znakiem dziesiętnym jest przecinek.
- Dla rysunków i tabel należy używać odsyłaczy sróconych: "Rys." lub "Tab." Wówczas nie będzie problemów z ich deklinacją w tekście. Jeśli takich typów nie ma w edytowanym dokumencie, to należy je utworzyć.
- Określanie wielkości obiektów (np. wektorów) składających się z pojedynczych elementów (np. skalarów) odbywa się przez zastosowanie myślnika "-" w pisowni łącznej, np. "magistrala 16-bitowa".
Zalecenia językowo-stylistyczne:
- Pod żadnym pozorem nie pisać w pierwszej osobie (pojedynczej ani mnogiej). Najlepiej pisać bezosobowo: wykonano, zaprojektowano, przesymulowano itp.
- Powstrzymywać się od stylu “felietonowego”. Unikać wszelkich słów-wytrychów (np.: oczywiście, niegdyś, jakkolwiek, po prostu, właśnie, w miarę, zapewne itp.)
- Uważać na tautologie (np. analogowy poziom napięcia — wystarczy: napięcie)
- Nie pisać “w tym projekcie…” — wystarczy: “w projekcie…” (wiadomo o czym się czyta).
- Nie pisać “na powyższym / poniższym rysunku…”, bo w trakcie edycji może on zmienić miejsce. Pisać: “na Rys. 17…” (oczywiście używając automatycznej numeracji oraz odsyłaczy).
- Nie budować zbyt długich ani zbyt złożonych zdań (jeśli chce się napisać wyraz “który” drugi raz w tym samym zdaniu, to znaczy, że chwilę temu trzeba było dać kropkę).
- Słowa “ilość” używa się przy określaniu rzeczowników niepoliczalnych (np. duża ilość danych), zaś dla policzalnych używa się słowa “liczba” (np. duża liczba bajtów).
- Budowa urządzenia opiera się na zasadach, a nie o zasady.
- W porównaniu z czymś, a nie do czegoś.
- Nie używać żargonu (np: podpiąć, wypuścić, …) — jego miejsce jest w języku mówionym, a nie pisanym.
- W miarę możliwości używać polskich odpowiedników słów angielskich, np.:
- hardware = sprzęt,
- software = oprogramowanie,
- hardware-software = sprzętowo-programowy,
- pin = wyprowadzenie, końcówka, sygnał,
- core = moduł,
- driver = sterownik,
- native = standardowy, rodzimy, naturalny,
- generic = ogólny, rdzenny, rodzajowy,
- master / slave = nadrzędny / podrzędny.
Fatalnie wyglądają "przeszczepy żywcem" (tzw. kalki językowe):
- zaembedowany (= wbudowany),
- inkrementacja (= zwiększanie),
- resetowanie (= kasowanie),
- kontroler (=sterownik),
- klikać (= przyciskać),
- maszyna stanów (=automat).
Jeśli już na prawdę nie można znaleźć zgrabnego polskiego odpowiednika (np.: chipset, front-end, framework), to słowo obce pisze się zawsze kursywą, pamiętając o zasadach pisowni odmiany (jeśli kończy się samogłoską, to przed końcówką dodajemy apostrof, jeśli spółgłoską — to nie).