Zasady dokumentowania wyników projektu

W Projekcie grupowym jest wymagane tworzenie dokumentacji projektowej. Realizacja projektu grupowego podlega obowiązkowemu i systematycznemu dokumentowaniu w SPG. Podstawowe wytyczne dotyczące tworzenia dokumentacji projektowej są następujące:

1. Definiuje się podstawowy zbiór dokumentów różnego typu, które muszą zostać sporządzone przez studentów każdej grupy projektowej
2. Obowiązują jednolite zasady edycyjne tworzenia dokumentów do projektu grupowego dla całego WETI, zgodne z wzorcami dokumentów umieszczonymi pod linkiem „Wzorce dokumentów” na dole strony.
3. Opiekun projektu:
   • może rozszerzyć/zmodyfikować zawartość każdego dokumentu, za wyjątkiem plakatu informacyjnego, jednak zawartość minimalna musi być zgodna z zawartością dokumentów wzorcowych (czyli np. można zmienić sposób udokumentowania, ale każdy element musi być zawarty albo można zrobić inaczej analizę ryzyka, ale musi być wykonana)
   • nie można pominąć żadnego typu dokumentu
   • opiekun projektu, jak również klient, może wymagać od grupy dodatkowych, niewyspecyfikowanych dokumentów, których zawartość określi, jednak ma obowiązek trzymać się jednolitego formatu dokumentu stosowanego na całym WETI.

Do zaliczenia przedmiotu wymaga się, aby studenci terminowo umieszczali dokumentację projektową w SPG.

W I semestrze Projektu grupowego należy wytworzyć następujące dokumenty:

1. Plakat informacyjny: zgodny ze wzorcem dokumentu, na koniec semestru I
2. Informacje o projekcie (akronim IoP): dokument zawiera informacje o projekcie i wykonawcach, celu, temacie i zakresie projektu, wstępnie planowanym zakresie prac oraz uproszczoną analizę ryzyka
3. Harmonogram i specyfikacja wymagań (akronim HiSW), który zawiera następujące informacje:
   • harmonogram projektu w I semestrze z podziałem na główne etapy i wskazaniem terminów ich realizacji
   • informacje dotyczące wskazania i opisania zadań i ról w projekcie (w kontekście etapów harmonogramu) oraz planowanego podziału zadań w zespole projektowym
   • specyfikację wymagań określonych dla projektu, nałożonych przez opiekuna i klienta itp.
4. Dokumentacja techniczna produktu (DTP): zawiera udokumentowane informacje dotyczące produktu, jego cech funkcjonalnych, parametrów technicznych, schematów blokowych, oprogramowania, wyników działania, zdjęć produktu itp.; o zakresie szczegółowym tego dokumentu decyduje opiekun w porozumieniu z klientem
5. Raport semestralny (akronim RS): zakres wykonanych prac i ich charakterystyka, rozbieżności wykonywanych prac w stosunku do planowanych, podsumowanie prac z wykazaniem pracy zespołowej, plany na II semestr, lista dokumentów końcowych z semestru I
6. Prezentacja wyników: prezentacja na zaliczenie przed komisją oceniającą.

W II semestrze Projektu grupowego należy wytworzyć następujące dokumenty:

1. Plakat informacyjny: zgodny ze wzorcem dokumentu, na koniec semestru II
2. Harmonogram i specyfikacja wymagań (akronim HiSW) który zawiera następujące informacje:
   • harmonogram realizacji projektu w II semestrze z podziałem na główne etapy i wskazaniem terminów ich realizacji
   • informacje dotyczące wskazania i opisania zadań i ról w projekcie (w kontekście etapów harmonogramu) oraz planowanego podziału zadań w zespole projektowym
   • specyfikację wymagań określonych dla projektu, nałożonych przez opiekuna i klienta itp.
3. Dokumentacja techniczna produktu (DTP): w najprostszym modelu należy rozwinąć, zaktualizować, uzupełnić, poprawić, zaktualizować dokumentację z I semestru, uwzględniając wartość dodaną z semestru II. Może też powstać nowy dokument. O zakresie szczegółowym tego dokumentu decyduje opiekun w porozumieniu z klientem
4. Raport końcowy (akronim RK): opis całego rozwiązania (np. oprogramowania, urządzenia, systemu) w docelowym kształcie oraz wyraźne wyjaśnienie, jakie części tego systemu lub urządzenia były dostępne w momencie rozpoczęcia projektu, a jakie zespół projektowy zrealizował (lub miał zrealizować) samodzielnie, zakres wykonanych prac i ich charakterystyka (prac w I i II semestrze), rozbieżności wykonywanych prac w stosunku do planowanych, podsumowanie prac z wykazaniem pracy zespołowej, lista dokumentów końcowych z obu semestrów.
5. Prezentacja wyników: prezentacja na zaliczenie przed komisją oceniającą.

Wszystkie dokumenty mogą być wielokrotnie aktualizowane, z podaniem nowego numeru wersji, przez cały okres realizacji projektu (w obu semestrach, w tym dokumenty z I semestru mogą być modyfikowane w II semestrze). Natomiast przy ocenie terminowości ich wytworzenia bierze się pod uwagę termin umieszczenia w SPG pierwszej wersji dokumentu, z tym że musi ona być zaakceptowana (zatwierdzona) w SPG przez opiekuna projektu.

Wzorce dokumentów