Android Dokumentacja techniczna projektu

Dokumentacja Projektu grupowego

Dokumentacja techniczna projektu

Wydział Elektroniki, Telekomunikacji i Informatyki
Politechnika Gdańska

Nazwa i akronim projektu: {nazwa projektu, np: System zabezpieczenia portu przed zagrożeniami terrorystycznymi - SZP}	Zleceniodawca: {nazwa/nazwisko klienta}
Numer zlecenia: {numer zespołu projektowego w ramach Projektu grupowego wg systemu SPG, np. 13@KSSR'2022}	Kierownik projektu: {kierownik zespołu projektowego}	Opiekun projektu: {opiekun projektu }

Nazwa / kod dokumentu: Dokumentacja techniczna produktu – DTP	Nr wersji: {wersja dokumentu np. 1.00}
Odpowiedzialny za dokument: {nazwisko, imię}	Data pierwszego sporządzenia: {data wykonania pierwszej wersji dokumentu}
	Data ostatniej aktualizacji: {data wykonania aktualnej wersji dokumentu}
	Semestr realizacji Projektu grupowego: {wpisać 1 lub 2}

Historia zmian

Wersja	Opis modyfikacji	Rozdział / strona	Autor modyfikacji	Data
1.00	{opis np. wstępna wersja}	{np. całość}	{nazwisko, imię}	{data zmiany}
{wersja}	{opis np. dodanie etapu C}	{np. pkt 2, 2.3}	{nazwisko, imię}	{data zmiany}

{UWAGA: w II semestrze dokumentacja może być rozszerzeniem dokumentacji z semestru I (nowa wersja dokumentu), może być też nowym plikiem}

Spis treści

1. Wprowadzenie - o dokumencie

   1. Cel dokumentu

   2. Zakres dokumentu

   3. Odbiorcy

   4. Terminologia

2. Dokumentacja techniczna projektu

3. Załączniki

Wprowadzenie - o dokumencie

Cel dokumentu

{nie zmieniać}

Celem dokumentu jest udokumentowanie informacji dotyczących produktu, jego cech funkcjonalnych, parametrów technicznych, schematów blokowych, oprogramowania, wyników działania, zdjęć produktu, pomiarów, testów oraz innych elementów wymaganych przez opiekuna i klienta.

Zakres dokumentu

{określenie, co wchodzi w zakres dokumentu, a co nie wchodzi, ew. wskazanie na dokumenty powiązane}

Odbiorcy

{określenie adresatów dokumentu, może być to typ odbiorcy; tu: zleceniobiorca (Katedra), członkowie zespołu projektowego oraz wymienione z nazwiska osoby, do których dokument ma dotrzeć}

Terminologia

{wyjaśnienie używanych w dokumencie pojęć i skrótów, oznaczenia używane wewnątrz dokumentu np. oznaczenia wymagań}

Dokumentacja techniczna projektu

{o zakresie dokumentacji decyduje opiekun, tu należy zacząć opis rozwiązania technicznego wg zaleceń opiekuna, w układzie redakcyjnym najlepiej oddającym charakter projektu – kolejne rozdziały, podrozdziały, punkty}

Załączniki

{wszelkie dokumenty nie dające się wkomponować w prosty sposób w tekst, należy dołączyć w osobnych plikach, a ich spis przedstawić w formie tabeli, przykładowo:}

Tabela 3.1. Lista załączników

L.p.	Nazwa dokumentu	Nazwa pliku
1.	Schemat funkcjonalny
2.	Schemat blokowy
3.	Schemat ideowy
4.	Wykaz elementów
5.	Karta katalogowa, itp.