Jak sporządzać sprawozdania z laboratoriów?

Cel sprawozdania:

Jak sama nazwa wskazuje sprawozdanie ma mieć funkcje „sprawozdawcze” czyli być udokumentowaniem wykonywanego ćwiczenia.

O sprawozdaniu należy myśleć w czasie zajęć!

1. Sprawozdanie musi zawierać:

1.1. Stronę tytułową.

1.1.1. Należy bezwzględnie korzystać z szablonu, wypełnionego ze zrozumieniem i zgodnie z wzorcem. Nie należy nic zmieniać w szablonie (czcionek, marginesów skracać tabelek itp.). Najprościej jest korzystać bezpośrednio z szablonu a nie kopiować jedynie tabelki (wówczas porażka jest niemal gwarantowana). W przypadku problemów ze stosowaniem szablonu, proszę o maila.

1.1.2. Numer ćwiczenia jest referencją i nie ma nic wspólnego z kolejnością zajęć.

1.1.3. Temat ćwiczenia ma być zgodny z harmonogramem – nie jest to treść zadania.

1.1.4. Lista osób ma zawierać osoby, które faktycznie robiły to ćwiczenie i to sprawozdanie, wobec tego twierdzenie „koledzy zapomnieli mnie dopisać” jest bzdurą. (patrz p.4.2 i 4.3). Dopisywanie osób nieobecnych jest jawnym oszustwem.

1.2. Treść zadania: ma być podana w sposób formalny i jednoznaczny. Treść zadania podawana w czasie laboratorium często jest przedstawiana w sposób luźny, gdyż odbywa się to w interakcji ze studentami – w czasie sprawdzania sprawozdania nie ma możliwości dyskusji!

1.3. Etapy pośrednie wypracowywania rozwiązania, jeśli takie miały miejsce. Przejścia między etapami mają być oczywiste na poziomie studenckim.

1.4. Przedstawienie rozwiązania. Jeżeli rozwiązaniem jest:

1.4.1. Program - to ma być on skomentowany. W przypadku prostych programów komentarz powinien mieć znacznie większą objętość od samego kodu. Należy komentować działanie programu, a nie działanie pojedynczych instrukcji, gdyż one czytającemu z pewnością będzie znane. Komentarz ma ułatwić/umożliwić zrozumienie algorytmu. Należy komentować wszelkie zmienne i stałe w programie a nawet akumulator jeśli jego zastosowanie w programie jest stałe (częste w przypadku programów studenckich) W przypadku programowania rejestrów procesora należy komentować nawet poszczególne bity. Komentarze nieprecyzyjne, trywialne, zbędne itp. oceniane są w sposób rozmyty, jednak nawet jeden komentarz błędny (niespójny z kodem), może być przyczyną nie zaliczenia sprawozdania. Przykład komentowania można zobaczyć w sprawozdaniu przykładowym.

1.4.2. Układ – ma być przedstawiony w postaci schematu ideowego narysowanego zgodnie z zasadami sztuki.

1.4.2.1. Na schemacie mogą znaleźć się wyłącznie elementy i połączenia, które były faktycznie używane i miały miejsce. (np. jeżeli była używana 2 wejściowa bramka NAND z jednym niepodłączonym wejściem to właśnie taka ma znaleźć się na schemacie (a nie NOT czy NAND z przypiętą „1”)

1.4.2.2. Elementy, których symbole nie determinują funkcji wyprowadzeń, mają mieć te wyprowadzenia opisane zgodnie z zasadami sztuki (czyli wewnątrz symbolu).

1.4.2.3. Schemat nie może być wygenerowany za pomocą programu, w którym zamiast symboliki stosowane jest bardziej artystyczne przedstawienie elementów. (bardzo modne w przypadku darmowych programów)

1.4.2.4. Wejścia i wyjścia powinny być rysowane jako „luźne” opisane wyprowadzenia zgodnie z treścią zadania i symbolami w równianiach (dotyczy zadajników stanu i wskaźników stanu – potocznie przycisków i lampek). Osoby bardzo ambitne mogę narysować rzeczywistość. (ale rzeczywistość rzeczywistą a nie domniemaną rzeczywistość czy teoretyczną rzeczywistość)

1.5. Informacje o finale ćwiczenia (z komentarzem). Niezależnie od wyniku ćwiczenia (pozytywny, negatywny) mają zostać przedstawione dane testowe oraz wyniki jakie uzyskiwano dla tych danych, z uwzględnieniem szczególnych przypadków. Radosne stwierdzenie „nie działało zgodnie z założeniami” jest optymalizacją treści kwalifikującą do niezaliczenia ćwiczenia. O niedziałającym rozwiązaniu można zazwyczaj napisać więcej niż o działającym.

1.6. Wnioski i uwagi końcowe – pożądane są przedstawienia nieudanych prób, z których wyciągnięto wnioski umożliwiające poprawne rozwiązanie problemu.

2. Sprawozdanie może zawierać (aczkolwiek zazwyczaj jest to żenujące):

2.1. Wstęp teoretyczny – relikt lat 80-tych, kiedy to nauczyciele (przede wszystkim w szkołach) wychodzili z prawidłowego założenia, że streszczanie kawałka rozdziału z podręcznika i przepisywanie go ręcznie spowoduje nabycie choć odrobiny wiedzy „na temat”. Dziś 99% „wstępów teoretycznych” w sprawozdaniach jest po prostu skopiowane z internetu na ogół bez czytania, zatem nie ma to najmniejszego sensu. Tym bardziej, że na ogół „zapomina się” o podaniu źródła, co w świetle prawa jest kradzieżą intelektualną. Sugeruję zatem zamieszczać wstęp teoretyczny wyłącznie wówczas jeśli będzie on własnego autorstwa i będzie zawierał ciekawe teoretyczne przemyślenia ściśle związane z tematem zadań do rozwiązania.

2.2. Zdjęcia, zrzuty ekranu lub filmy. Zazwyczaj nie ma to sensu, a ma zastępować treść merytoryczną.

2.3. Wydruki plików *.hex, *.bin itp.

2.4. Opisy zajęć nie związanych z realizacją zadania (na wprowadzeniu dowiedzieliśmy się że…, układ podłączyliśmy do prądu, itp.)

2.5. Fragmenty cudzych dokumentacji (elementów, kitów), bez wyraźnej potrzeby odwoływania się do nich w treści sprawozdania.

2.6. Duże fragmenty kodu nie swojego autorstwa (np. otrzymanych przez prowadzącego jako kod bazowy czy demonstracyjny).

3. Sprawozdanie nie może zawierać:

3.1. Jakichkolwiek fragmentów (w tym również rysunków) nie swojego autorstwa bez wyraźnego wskazania, że jest to cytowanie. Wszelkie zapożyczenia mają mieć precyzyjnie podane źródło. Proszę jednak zwrócić uwagę, że ze względu na charakter sprawozdania (patrz początek tekstu) zapożyczenia są raczej zbędne. Z zastrzeżenia tego wyłączona jest oczywiście treść zadań.

3.2. Rozwiązań innych zadań niż te, które były do rozwiązania na zajęciach.

3.3. Rozwiązań zadań w inny sposób niż narzucony na zajęciach.

3.4. Korespondencji z prowadzącym, komentarzy do zwrotów itp. (dla takich komentarzy baza przewiduje specjalne pole).

4. I ogólnie:

4.1. Sprawozdanie ma być napisane poprawnym językiem zgodnym z językiem studiów (dotyczy to również komentarzy w programach).

4.2. Sprawozdanie może być tworzone indywidualne lub w większym gronie ale nie może być robione przez jedną osobę za kilka osób. Osoby przychodzące na konsultacje w sprawie dyskusji nad sprawozdaniem, stwierdzające „nie wiem, nie ja to pisałem” automatycznie mają sprawozdanie niezaliczone. Z tego powodu niezalecane jest, aby oddawać jedno sprawozdanie za całą sekcję, jeśli w czasie zajęć istniał podział na podsekcje.

4.3. Sprawozdania robione przez kilka osób ma być wysyłane (wysyłane a nie robione) tylko przez jedną osobę z zaznaczeniem za kogo jest wysyłane. Jeśli jest to niemożliwe, np. w przypadku odrabiania z inną grupą (przy wysyłaniu da się zaznaczyć wyłącznie osoby z grupy), taka osoba powinna wysłać dokładnie to samo sprawozdanie indywidualnie.

4.4. Minimalna „objętość” sprawozdania to 2 strony – wynika to z tego, że strona tytułowa jest narzucona i nie ma na niej się znajdować nic więcej.

4.5. Ze względu na to, że sprawozdania mają wyłącznie formę elektroniczną (i nie powodują marnotrawstwa papieru) nie jest określona maksymalna „objętość” sprawozdania, jednak sprawozdania sztucznie „napompowane” pustosłowiem, zdjęciami, cytatami itp. będą zwracane. (patrz p. 2)

4.6. Sprawozdanie (i w konsekwencji całe ćwiczenie) może być niezaliczone bez możliwości dalszych popraw w przypadku:

4.6.1. Wysłania sprawozdania w całości lub fragmentach nie swojego autorstwa.

4.6.2. Zmiany rozwiązań zadań z wersji na wersję. Sprawozdanie ma być dokumentacją wykonanego ćwiczenia zatem treść rozwiązań nie może się zmieniać po zakończeniu laboratorium. Treść rozwiązań może się zmieniać pod warunkiem, że zostały faktycznie wykonane dodatkowe prace, testy itp. (np. w ramach konsultacji). Wówczas cały tok pracy musi być udokumentowany w sprawozdaniu.

4.6.3. Wysyłania popraw sprawozdania ignorującego przedstawiane uwagi.

4.6.4. Dużej liczby prób poprawy, wskazującej bardziej na zgadywanie niż zdroworozsądkowe poprawienie.

4.6.5. Wpisania osób, które nie uczestniczyły w ćwiczeniu i tworzeniu sprawozdania.

4.6.6. Wysłania sprawozdania o wyjątkowo żenującej treści. (zazwyczaj jedynie w celu dotrzymania terminu oddania)

4.7. Pomimo formy elektronicznej sprawozdanie musi być gotowe do wydruku na kartkach A4 (czasem na życzenie różnych komisji zachodzi potrzeba druku). Jedynym dopuszczalnym formatem jest *.pdf (nie *.doc, *.rar, *.zip, *.asm, *.txt, *.c, *.sch itp.), chyba że z prowadzącym wyraźnie i jednoznacznie ustalono coś innego.

4.8. Po „wydrukowaniu” sprawozdania do pdf należy je obejrzeć. Drobne błędy edycyjne nie spowodują zwrotu, jednak strona tytułowa zajmująca dwie strony, treść właściwa wychodząca na stronę tytułową, czy puste lub prawie puste strony, to nie są drobne błędy.

4.9. Sprawozdania należy formatować „jak normalny dokument”. Jako że definiowanie „normy” jest trudne modne przykłady „nie-normy”: centrowanie treści zwykłego tekstu, sprawozdania w żałobnej ramce, bardzo kolorowe czcionki, tekst pisany boldem, czcionki powyżej 12pkt, spis treści, podział na rozdziały zaczynające się każdy na nowej stronie, stosowanie przeplotu w przypadku 2 lub więcej zadań. Przez przeplot (czyli tak nie robić) należy rozumieć układ typu: 1.treść zadania A,B; 2. koncepcja rozwiązania A,B; rozwiązanie A,B; schemat A,B; wnioski A,B. Powinien być najpierw ciąg rozumowania dla zadania A, potem dla B.

4.10. Sprawozdania z dużą liczbą braków, otrzymują komentarz sugerujący kontakt osobisty. Proszę nie pisać maili z pytaniem „co jest źle”, a po prostu przyjść na konsultacje.

4.11. Bardzo często, najprostszą metodą poprawy sprawozdania, jest wizyta w laboratorium i uzupełnienie badań/eksperymentów. Jeśli badania były nierzetelne czy nierzetelnie zanotowane, poprawienie sprawozdania może być niemożliwe. No chyba że w „cudowny” sposób, odnajdą się rzetelne, wcześniej nie wykorzystywane do celów tworzenia sprawozdania notatki. Ale w cuda nie wszyscy wierzą.

4.12. Sprawozdania należy oddawać wyłącznie przez bazę. Sprawozdań (oraz komentarzy, tłumaczeń do sprawozdań itp.) nie należy próbować wysyłać mailem.

4.13. Przy wysyłaniu sprawozdania pole komentarz wypełnia się w bardzo szczególnych przypadkach. Wpisywanie tam: „przesyłamy poprawione sprawozdanie”, „poprawiono schematy” jest zbędne.

4.14. Jeżeli po oddaniu sprawozdania, autorzy stwierdzą (jeszcze przed zwrotem przez prowadzącego), że nie jest ono poprawne, mogą oddać je ponownie, nadpisując poprzednią wersję. (poprzednia wersja nie jest wówczas sprawdzana)

4.15. Automatycznie, zaraz po oddaniu sprawozdania, jego status musi się zmienić na „oddane”. Jeśli to nie nastąpiło to znaczy, że zostało ono oddane nieprawidłowo. (zazwyczaj pomylony jest numer ćwiczenia)

4.16. Sprawozdanie należy zaadresować do osoby prowadzącej dane ćwiczenie. (można to sprawdzić w harmonogramie).

4.17. O sprawozdaniu należy myśleć już w czasie zajęć, najlepiej robiąc odpowiednie notatki. Sprawozdanie ma dokumentować przebieg merytoryki ćwiczenia a nie być zlepkiem elementów związanymi z ćwiczeniem.

Przykładowe poprawne sprawozdanie (nie idealne) można zobaczyć tutaj.

(niniejszy opis może ewaluować, jednak nigdy nie będzie zmieniać ustalonych zasad)