Jak pisac raporty

Poniżej znajduje się kilka wskazówek, w jaki sposób napisać dobry raport z przeprowadzonego ćwiczenia. Stosowanie się do nich jest mocno zalecane.

Ocenianie raportu:

  • Raport na 5 – prezentuje, że zrealizowane zostały wszystkie cele oraz spełnione wszystkie wymagania ćwiczenia, zawiera bogatą, własną analizę wyników, znajduje się w nim niewielka liczba, mało istotnych błędów.
  • Raport na 4 – prezentuje, że zrealizowane zostały wszystkie cele ćwiczenia, jednak analiza wyników i wyciągnięte z ćwiczenia wnioski są ubogie.
  • Raport na 3 – prezentuje, że zrealizowana została większość celów ćwiczenia, w tym te najistotniejsze, analiza wyników jest szczątkowa, zawiera poważne błędy jednak nieprzekreślające sensowności ćwiczenia.
  • Raport na 2 – każdy, który nie pasuje do żadnej powyższej kategorii.

Raport powinien być dostarczony w formie drukowanej dwustronnie oraz dodatkowo przesłany mailem. Do maila powinny być dołączone wszystkie pliki wykonane w trakcie realizacji projektu. Powinny one umożliwiać odtworzenie wyników doświadczenia. Jeżeli pliki zajmują sumarycznie ponad 1 MB powinny zamiast być dołączone do maila, znajdować się w Internecie na jakimś serwerze (np. sirius). Można także dostarczyć je na płycie CD/DVD.

Oceniana jest jakość raportu, a nie jego długość. Sztuczne wydłużanie raportów poprzez umieszczanie w nich:

  • długich wstępów teoretycznych,
  • powtarzanie tych samych informacji,
  • stosowanie dużych odstępów między wierszami i wielkości czcionek,
  • używanie dziwnych czcionek,
  • wklejanie dużej ilości niepotrzebnych zrzutów ekranu,
  • wklejanie całego kodu źródłowego programu,
  • przepisywanie wikipedii,
  • itp.

nie pomoże w uzyskaniu wysokiej oceny, a co najwyżej w tym zaszkodzi, poprzez wywołanie frustracji u sprawdzającego raport, który będzie musiał to czytać i oglądać.

Poniżej kilka rad odnośnie pisania raportów:

  • Raport powinien być sformatowany czytelnie i spójnie. Niewskazane jest nadużywanie dziwnego formatowania w stylu “czego to ja nie potrafię zrobić w MS Word”. Ambitnym studentom, którzy chcą się nauczyć pisać dobrze wyglądające dokumenty i łatwo wprowadzać skomplikowane wzory matematyczne, polecam zapoznanie się z systemem LaTeX (czyt. latech) lub z opartym na nim prostym w obsłudze edytorem wizualnym LyX. Jako edytor LaTeXowy pod Windows polecam TeXnicCenter, a pod Linuxa Kile. Nie mniej wybór edytora tekstu nie wpływa w żaden sposób na uzyskaną ocenę.
  • Wikipedia nie jest uważana za niepodważalne źródło informacji. Zdarza się, że stosowana w niej terminologia jest błędna lub nieścisła (znajdywałem już w niej błędy np. pomylenie problemów NP trudnych i zupełnych). W przypadku błędów wynikających z błędów w wikipedii reklamacje nie będą uwzględniane. To samo dotyczy oczywiście informacji znalezionych na prywatnych stronach www.
  • Mimo, że obie formy są już dopuszczone do użytku, w celu zachowania precyzyjności należy pamiętać, aby z rzeczownikami policzalnymi używać słowa liczba, a z niepoliczalnymi ilość. Np. liczba procesorów, ilość miejsca na dysku.
  • Wykresy powinny być czytelne, osie oraz serie danych opisane, jednostki podane. Jeżeli oddawany wydruk drukowany jest w trybie czarno-białym należy zwrócić uwagę, czy serie danych są w łatwy sposób rozróżnialne. Jeżeli ktoś używa LeTeXa polecam wklejać wykresy w postaci wektorowej, a nie rastrowej – na wydruku wyglądają zdecydowanie lepiej. Takie wykresy generowane są np. przez gnuplota lub Matlaba.
  • Przed wydrukowanie raportu należy użyć spell checkera.