dr inż. Mateusz Smoliński

Etapy i zasady przygotowania prac i raportów końcowych dla studiów podyplomowych:

Poniższe zasady usprawniają przygotowanie pracy/raportu końcowego, który spełni wymagania określone przez Politechnikę Łódzką.

1. Ustalenie tematu, celu i zakresu pracy (w języku polskim). Wybór formatu realizacji: praca lub raport końcowy, przy czym oba formaty umożliwiają spełnienie efektów kształcenia. Raport końcowy jest uproszczoną formą pracy końcowej dokumentującą wykonanie raportu końcowego (m.in. zawiera mniej rozdziałów co przekłada się na mniejszą liczbę stron). Zarówno praca jak i raport końcowy musi być złożony przed wyznaczonym przez kierownika terminem ukończenia prac końcowych, który jest ustalany indywidualnie dla edycji studiów podyplomowych.

2. Zapoznanie się z efektami kształcenia wymienionymi w karcie przedmiotu praca końcowa (dostęp przez zasoby kursu w platformie WIKAMP lub na stronach WWW studiów podyplomowych z zakładce Program Studiów->Karty przedmiotów). Realizacja pracy/raportu końcowego wymaga spełnienia wszystkich efektów kształcenia.

3. Przedstawienie prezentacji przedstawiającej temat, cel i zakres pracy, technologie oraz założenia funkcjonalne na seminarium. Przed każdym wygłoszeniem zalecane przesłanie prezentacji do promotora.

4. Przygotowanie literatury (artykuły i książki wydane po 2001 roku, adresy URL mogą stanowić tylko 20% bibliografii. Każdy adres URL musi zostać uzupełniony o datę, kiedy strony były wyświetlane. Wymagane min. 7 książek, łącznie min. 10 pozycji literatury, dozwolone zamieszczanie w wykazie literatury jedynie autorytatywnych źródeł informacji np. Wikipedia nie jest autorytatywnym źródłem informacji, ponieważ publikowane informacje nie podlegają wiarygodnej weryfikacji. Publikacje książkowe uznaje się za autorytatywne ponieważ tekst książki przed publikacją podlega recenzji, podobnie z opublikowanymi artykułami naukowymi. Format wpisu bibliograficznego (w tym wymagane informacje) należy dostosować do obowiązujących standardów (np. dla książki oprócz autora i tytułu wymagane jest podanie numeru wydania, wydawnictwa oraz daty wydania). Zalecane zapoznanie się z przykładową bibliografią zamieszczoną w książce lub pracy/raporcie końcowym.

UWAGA: Poprawnie przygotowana bibliografia pracy końcowej pozwala na stworzenie w treści pracy odwołań do definicji pojęć, dokumentów standaryzacyjnych, technologii, istniejących rozwiązań problemów oraz aktualnie przeprowadzonych światowych badań.

5. Gdzie szukać książek i artykułów? Zalecane lokalizacje:

• kurs Literatura naukowa w platformie WIKAMP
• księgozbiór biblioteki głównej PŁ
• portali ibuk Libra, NASBI oraz Ebook Central z książkami w wersji elektronicznej (dostęp do portali jest zapewniany przez BG PŁ) a także w serwisie Tech book for free download 
• portale z artykułami i źródła elektroniczne udostępniane przez BG dla wydziału FTIMS m.in. zalecane sprawdzenie tematyki w katalogach: Web of Science (WoS), IEEE/IET Electronic Library (IEL) oraz ACM (poprzez ProQuest), portalach wydawnictw Elsevier/Springer,
• ogólnodostępne dokumenty elektroniczne artykuły oraz książki
• dokumenty organizacji standaryzacyjnych RFC, W3C, IEEE itp.
• wszelkie inne legalne źródła dostępu do wiedzy.

Jeżeli w w/w źródłach wiedzy nie występuje poszukiwana książka niezbędna do realizacji pracy/raportu końcowego, można zgłosić jej zakup do Biblioteki Głównej Politechniki Łódzkiej poprzez procedurę złożenia propozycji zakupu książek.

Zapoznając się z pozycjami bibliografii warto utworzyć własny indeks roboczy z odwołaniami do stron WWW artykułów oraz książek w wersji elektronicznej.

6. Z wykorzystaniem udostępnionego wzorca raportu końcowego/pracy końcowej (tzw. makieta zapewnia normalizację formatu pracy) w formacie ODT zamieszczonego w kursie studiów podyplomowych na platformie WIKAMP należy przygotować pierwszą wersję pracy:

• zapoznać się z zasadami edycji makiety zamieszczonymi w dodatku makiety,
• dostosowując odpowiednio nazwę pliku do formatu: Imie_Nazwisko_v0.1.odt, w nazwie pliku nie należy umieszczać znaków diakrytycznych,
• wypełniając stronę tytułową, zalecane wstawienia jako daty oddania pola z datą bieżącą,
• przygotowując opis w rozdziałach: wstęp (m.in. przedmiot pracy, opis celu i zakresu pracy) i założenia projektowe (m.in. opis środowiska developerskiego i produkcyjnego, architektury oprogramowania,  stos technologiczny - kompletny zbiór wykorzystanych technologii i rozwiązań wraz z wersjami stosowanych standardów, w przypadku wykorzystania gotowych implementacji należy podać nazwy i oznaczenia wersji, wypunktowanie wszystkich reguł biznesowych/przetwarzania danych dla tworzonego rozwiązania. oraz opis środowiska działania oprogramowania wraz z jego ograniczeniami, zastosowane modele itp.), W rozdziale "Założenia projektowe" można tworzyć podrozdziały.
• opracowując tematyczny układ podrozdziałów dla rozdziału "Realizacja projektu" (tzw. szczegółowy plan pracy końcowej), każdy podrozdział musi posiadać unikalny numer. W przypadku własnych implementacji należy w wyróżnić podrozdział opisujący projekt, należy wymienić wszystkie poziomy dostępu oraz przypadki użycia zapewniane przez aplikację biznesową. Wymagane uwzględnienie dla każdego przypadku użycia scenariuszy pozytywnych oraz scenariuszy błędów z opisem sposobu ich obsługi itp. W przypadku wykorzystania baz danych należy przedstawić pełną specyfikację ich struktur wraz z wszystkimi ograniczeniami bazodanowymi. W układzie dokumentu pracy dopuszcza się co najwyżej trzy numerowane poziomy zagnieżdżenia rozdziałów.
• wypełniając rozdział bibliografia/źródła, pozycje literatury należy posortować alfabetycznie względem autora lub chronologicznie względem daty publikacji,
• stosując przynajmniej jedno samodzielnie wygenerowane automatyczne odwołanie do pozycji literatury w tekście pracy. Przykładowe odwołanie do pozycji literatury wystarczy zamieścić je w przykładowym zdaniu, które na tym etapie pracy nie musi być powiązane tematycznie z pozycją literatury. Należy pamiętać, że w bibliografii nie można umieścić pozycji literatury, do której nie występuje przynajmniej jedno odwołanie w treści pracy.

Każde odwołanie do rozdziału, tabeli, rysunku oraz wzoru z treści pracy musi zawierać unikalny i aktualny numer tego obiektu (nie należy stosować statycznych odwołań ani określeń powyższy/poniższy). Wymagane stosowanie jedynie dynamicznie aktualizowanych odwołań, które po poprawnym utworzeniu gwarantują aktualność odwołań nawet w sytuacji dowolnych, kolejnych aktualizacji pracy końcowej.

UWAGA: Należy zapewnić wersjonowanie dokumentu poprzez umieszczenie w końcówce nazwy pliku numeru wersji v0.21, który będzie zwiększany po aktualizacji pracy (wersja v1.0 oznacza pracę/raport końcowy z kompletnymi wszystkimi rozdziałami, przy czym możliwe jest tworzenie kolejnych wersji v1.1 itd).

7. Każda wersja pracy/raportu przesłana do promotora musi być w formacie PDF i zawierać:

• w nazwie pliku dane autora oraz numer wersji, ostatni człon nazwy pliku odpowiedni dla studiów podyplomowych_splinux_eNR lub _spjava_eNR, gdzie NR jest numerem edycji studiów podyplomowych
• tekst pracy musi posiadać jednolite formatowanie zgodne z udostępnioną wzorcową makietą,
• spójną treść pracy w ramach dotychczas przygotowanych rozdziałów.
• w treści wiadomości wymagany krótki opis wyjaśniający, które rozdziały mają zostać sprawdzone przez promotora z rozróżnieniem na rozdziały z już wykonanymi korektami oraz nowe.  Przed przysłaniem pracy dyplomowej do promotora należy przeczytać dodane/modyfikowane fragmenty pracy i upewnić się, że w treści nie występują żadne problemy znane ze składu tekstu tj. wdowy, bękarty, szewcy, sieroty.
• każda wersja pracy przesłana do promotora musi być też wgrana poprzez aktywność "Praca końcowa" zamieszczoną w dedykowanym dla studiów podyplomowych kursie na platformie WIKAMP.

Zalecane wgrywanie kolejnych wersji pracy w formacie ODT na platformę WIKAMP do "Moich plików prywatnych" co zapewni regularne tworzenie kopii zapasowych,  dodatkowo należy zadbać o regularne wykonanie i zabezpieczenie kopii zapasowej plików (np. archiwum ZIP) zawierających część praktyczną pracy/raportu końcowego (np. można zapisywać ją w aktywności "Moich plików prywatnych" na platformie WIKAMP lub zewnętrznym nośniku/repozytorium) .

8. Stworzenie środowiska roboczego (dobór narzędzi i ich konfiguracja), przygotowanie badań (dobór metod badawczych).

9. Zapoznanie się z wymaganymi do wykonania części praktycznej pracy technologiami. Wykonanie niezbędnych do utworzenia raportu/pracy końcowej badań/eksperymentów i implementacji.

10. Przygotowanie treści kolejnych rozdziałów pracy końcowej.  Opis wszystkich przedstawianych w raporcie/pracy końcowej zagadnień musi być precyzyjny i jednoznaczny w interpretacji. Należy zadbać o poprawne nazewnictwo pojęć, zgodne z przyjętymi w literaturze definicjami.  Treść pracy końcowej może jedynie zawierać oficjalne sformułowania względem obowiązującego dla pracy języka. Każda część przygotowanej pracy/raportu końcowego wymaga weryfikacji przez promotora, sugestie i uwagi promotora są zamieszczane w formie komentarzy PDF.

11. Przed każdym spotkaniem z promotorem należy przysłać wiadomość e-mail z powiadomieniem o spotkaniu załączając bieżącą wersję pliku pracy/raportu końcowego. Zalecany termin spotkania ustalany w ramach obowiązujących godzin konsultacji promotora.  Jeżeli praca dyplomowa jest realizowana przy współpracy firmy IT/ICT, wówczas wszystkie ustalenia z pracownikami firmy należy udostępnić promotorowi: w przypadku korespondencji e-mail wystarczy promotora umieścić w polu DW, a w przypadku spotkań/telekonferencji/rozmowy telefonicznej z pracownikami firmy po każdym spotkaniu z pracownikami firmy należy sporządzić notatkę uwzględniającą wszystkie uzgodnienia i załączyć ją do wiadomości e-mail.

12. Przed oddaniem finalnej wersji pracy/raportu końcowego wymagane zaprezentowanie promotorowi kompletnej i poprawnie działającej części praktycznej wykonanej w ramach realizacji projektu końcowego. 

13. Wersja finalna pracy/raportu końcowego jest ustalana przez promotora. Wersja finalna pracy/raportu końcowego musi być kompletnym dokumentem po wszystkich korektach i spełniać wszystkie wymagania określone dla prac/raportów końcowych realizowanych w ramach studiów podyplomowych na Politechnice Łódzkiej.

14. Przed złożeniem finalnej wersji pracy/raportu końcowego u promotora należy sprawdzić:

• w edytorze tekstowym poprawność zapisu treści pracy w języku polskim,
• czy zostały osiągnięte wszystkie efekty kształcenia przedmiotu praca końcowa,
• czy formatowanie dokumentu raportu końcowego jest zgodne z wzorcową makietą, w przypadku realizacji pracy końcowej należy zweryfikować spełnienie wymagań określonych w załączniku 1 pt. WYTYCZNE PRZYGOTOWANIA PRACY KOŃCOWEJ opublikowanego dokument REGULAMIN STUDIÓW PODYPLOMOWYCH W POLITECHNICE ŁÓDZKIEJ. czy zawartość załączonego do pracy nośnika danych jest kompletna, tzn. czy zawiera:
  • w głównym katalogu dokument pracy w formacie edytowalnym DOC/ODT i PDF,
  • wszystkie pliki wytworzone w ramach realizacji części praktycznej pracy np. w pracach implementacyjnych archiwum ZIP z kodem źródłowym dla finalnej wersji oprogramowania, oprócz tego kod skompilowany w formacie WAR/JAR/EAR, struktury bazy danych i dane inicjujące bazę (dwa osobne pliki zawierające kwerendy SQL) - Finalna wersja projektu z kodem źródłowym nie może być oznaczona jako SNAPSHOT, wraz z odpowiednią konfiguracją np. jeżeli wykorzystano komponenty JSF to w deskryptorze wdrożenia web.xml należy wartość atrybutu PROJECT_STAGE zmienić z Development na Production,
  • wszystkie pliki konfiguracyjne, pliki z wynikami eksperymentów, zasoby niezbędne do uruchomienia rozwiązania w tym niezbędne do uruchomienia oprogramowanie,
  • w głównym katalogu plik tekstowy dane_dostepowe.txt z wszystkimi danymi dostępowymi, dla każdego zestawu danych dostępowych wymagane określnie poziomu dostępu i gdzie mają zastosowanie (identyfikacja systemu/aplikacji/usługi).
  • w przypadku zastosowania środowiska wirtualizacji na oddawanych nośnikach należy zamieścić wyeksportowane wirtualne maszyny wraz z wersją wykorzystywanego w projekcie końcowym nadzorcy wirtualizacji. Nie należy umieszczać instalacyjnych obrazów ISO systemów operacyjnych.
  • nadaną nazwę nośnika, która przynajmniej musi zawierać nazwisko autora, a jeżeli oddawanych jest wiele nośników wymagane umieszczenie w nazwie ich numeru.

UWAGA: Zawartość nośnika musi być wystarczająca do odtworzenia środowiska zgodnie z przygotowaną instrukcją wdrożenia i powtórzenia wykonanych eksperymentów wykonanych w ramach realizacji projektu końcowego.

• kompletność i spójność poszczególnych części pracy, wymagane uważne przeczytanie całości pracy/raportu końcowego,
• czy w dokumencie podano ścieżki do wszystkich wymienionych plików konfiguracyjnych/zasobów, czy dla wszystkich utworzonych komponentów/klas/interfejsów podano pełne nazwy pakietów oprogramowania (zaczynające się od odwróconej nazwy domenowej pl.lodz.p.it.spjava), do których elementy te należą.
• sprawdzić kompletność opisu instrukcji wdrożenia oraz czy ścieżki do wymienionych plików z załączonego nośnika danych są poprawne,
• przygotować dokument PDF z treścią pracy,
• czy wszystkie odwołania w treści pracy w dokumencie PDF (rysunki, tabele, rozdziały, strony, pozycje literatury itp.) są aktualne,
• czy spis treści i indeksy w dokumencie PDF zawierają aktualne odwołania do stron, czy odwołania do źródeł są prawidłowe
• aktualność informacji na stronie tytułowej raportu/pracy m.in. data powinna być zgodna z datą zaakceptowania finalnej wersji pracy przez promotora

15. Po zaakceptowaniu przez promotora finalna wersja pracy/raportu końcowego podlega PROCEDURZE ODDANIA PRACY KOŃCOWEJ. Wymagane oddanie promotorowi przygotowanej zgodnie z wcześniejszymi wytycznymi nośnika/nośników i podpisanego oświadczenia dotyczącego autorstwa pracy (wymagany wzór dokumentu zgodny z wyznaczonym przez regulamin studiów podyplomowych organizowanych przez Politechnikę Łódzką) nie później niż przed wyznaczonym przez kierownika terminem ukończenia prac/raportów końcowych. Wgrywając finalny dokument pracy/raportu końcowego na platformę WIKAMP wymagane umieszczenie w komentarzu w aktywności praca końcowa zgody lub jej braku na publiczne udostępnienie finalnej wersji dokumentu bez ograniczeń lub udostępnienie jedynie dla uczestników kolejnych edycji studiów podyplomowych np. "Wyrażam/nie wyrażam zgody na publiczne udostępnienie wgranego dokumentu pracy końcowej bez ograniczeń."

17. Dla złożonej finalnej wersji pracy/raportu końcowego promotor wypełnia protokół oceny uwzględniając spełnienie efektów kształcenia (format ustala załącznik nr 3 do Uchwały Nr 9/2014 Senatu Politechniki Łódzkiej z dnia 18 czerwca 2014r Zasady organizacji i prowadzenie studiów podyplomowych w Politechnice Łódzkiej). Ustalona przez promotora ocena z pracy/raportu końcowego jest wstawiana do dziennika ocen w kursie studiów podyplomowych na platformie WIKAMP.

UWAGA: Jeżeli chcesz podzielić się własnym doświadczeniem z realizacji pracy/raportu końcowego umieść poniżej własny komentarz z zaznaczeniem czy realizowana była praca czy raport końcowy, podaj nazwę i edycję studiów podyplomowych, w których uczestniczyłeś. W komentarzu uwzględnij łączny czas realizacji pracy/raportu końcowego (z podziałem na część praktyczną i dokument) oraz zamieść własne sugestie i porady, jak usprawnić przygotowanie projektu/pracy/raportu końcowego.

Termin odbioru świadectw ukończenia studiów podyplomowych zostanie ogłoszony przez kierownika studiów podyplomowych, ich wydanie zapewnia Sekcja Dyplomów PŁ.

Przydatne narzędzia

Do tworzenia infrastruktury (segmenty sieci i wirtualne maszyny) zalecane wykorzystanie środowiska wirtualizacji VirtualBox

Edytor dokumentów ODT Writer z najnowszego stabilnego pakietu biurowego LibreOffice

Do tworzenia schematów graficznych polecam stronę draw.io lub narzędzie dia posiada eksport do formatu obrazu jpg/png (opis diagramu w formacie XML można generować automatycznie).