Struktura raportu zaliczeniowego

Ponieważ pojawiają się pytania o to, co powinno być w raporcie do zadania, to postanowiłem tutaj napisac krótką notatkę na ten temat. Dla zadań z WBO i ONA raporty powinny mieć podobną strukturę, więc piszę jedną notatkę.

1. Państwa raporty nie będą oceniane pod kątem formalnym, więc nie ma jednego wzorca/szablonu. Jest to dla Państwa ćwiczenie w swobodnym wypowiadaniu się na piśmie.

2. Kluczowa dla raportu jest zwięzła komunikacja. Nie ma powodu, aby nadmiernie rozwlekać tę formę wypowiedzi. Zakładamy, że i autor i czytelnik zna treść zadania i posiada niezbędny kontekst wiedzy, aby zrozumieć podstawowe pojęcia. Tylko jeśli wykorzystują Państwo jakieś biblioteki lub techniki spoza wykładu proszę o ich objaśnienie (też zwięzłe).

3.  W Państwa raportach powinny znaleźć się 2 części: a) opis implementacji b) opis wyników.
Część a) nie musi powtarzać treści zadania, a jedynie zająć się opisem rozwiązania problemu implementacyjnego. Żeby napisać swój program, musieli Państwo podjąć jakieś decyzje: jakich bibliotek użyć, jak obsłużyć konfigurację programu (parametry), jak reprezentować dane w pamięci, w jakim formacie zapisywać wyniki. Tutaj też jest miejsce na uwzględnienie źródeł internetowych, którymi się Państwo “inspirowali” podczas pisania. Jeśli uważają Państwo, że coś można byłoby zaimplementować lepiej, ale brakło Państwu czasu – tutaj warto o tym napisać. Część a)będę pewnie czytał przed czytaniem kodu, więc w idealnym przypadku po przeczytaniu części a) raportu będę wiedział czego spodziewać się w kodzie źródłowym.
Część b) ma z kolei dać mi obraz tego, czego się Państwo nauczyli wykonując zadane obliczenia przy pomocy napisanego programu. Zwykle tu znajdują się jakieś wykresy lub tabele przedstawiające wyniki. Jeśli dane przykładowe nie są wystarczające do pełnej odpowiedzi na pytanie, warto to uwzględnić i albo dodać jakieś inne dane, albo przynajmniej skomentować jakich danych zabrakło do pełnego zrozumienia problemu. Część b powinna być podsumowana jakimiś wnioskami. Bardzo proszę o nie “wypełnianie” sztucznie przestrzeni ogromnymi wykresami – to naprawdę robi złe wrażenie.

Całość nie ma wyznaczonej minimalnej i maksymalnej objętości, ale zasadniczo, zwykle część a) nie powinna przekraczać 1 strony a4 (chyba, że zrobili Państwo coś istotnie więcej niż było w wymaganiach). Część b) też zwykle mieści się na 1-2 stronach a4,  zależnie od zadania, dla ONA pewnie raczej 1, dla WBO pewnie raczej trochę więcej. Oczywiście,  w sytuacji, gdy ktoś dużo zrobił i ma dużo wniosków można to trochę wydłużyć. Jeśli komuś wychodzi ponad 4 strony, to pewnie można to spokojnie skrócić. Jeśli mają Państwo mniej niż 3 akapity tekstu (części a,b i wnioski), to pewnie nie wszystko Państwo napisali.

Co bardzo istotne – nawet długi raport z kiepsko wykonanego projektu nie może być dobrze oceniony. Nie mogą Państwo “nadrobić” braku implementacji i wyników kwiecistymi “opisami przyrody”. Jednak, nawet najlepsza implementacja, wymaga jakiegoś podsumowania i opisania.

W razie dodatkowych pytań, proszę o komentarze do wpisu tutaj.

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>