Przykładowy projekt
Nazwa projektu
Opis w bardzo prostych słowach, na temat tego do czego służy ten projekt i co on robi.
Max. 5 zdań.
Osoby odpowiedzialne:
- Jan Kowalski
- etc
Gdzie można znaleźć ten projekt? Opisać gdzie ten projekt się znaduje, czy np. jest to na jakiejś stronie internetowej, czy w miejscu na formule bądź bolidzie.
Jak z niego korzystac?
Jeżeli twój projekt został zrealizowany dla wszystkich w formule, w tym miejscu powinna znaleźć się dokładna instrukcja jak korzystać z danego rozwiązania. Np. dla kreatora dokumentów ofertowych, powinien być opis jak to wyklikać, co się kiedy dzieje, itp.
Część techniczna
Część przeznaczona dla osób z Sekcji Informatyki bądź elektroniki, bądź zainteresowanych szczegółami projektu.
Linki do repozytorium
Cele
Opis tego jakie cele chcielibyśmy uzyskać i jakie projekt powinien spełniać cechy Przykładowo, jeżeli mielibysmy projekt internetowego włącznika do światła, to byłoby to:
- Dostępność (Łatwo wejść na strone i przełączyć światło)
- Skalowalność ( proste dodawanie kolejnych guzików żeby móc pstrykać więcej lampek)
- Wydajność (mając podłączonych 1000 lampek do systemu, po kliknięciu przełączą sie one i tak w 1 sekundę )
Założenia projektowe
Przykładowo, założeniem projektowym są odgórne limity i wymagania które projekt musi spełnić, np. ograniczeniem telemetrii jest układ STM32, albo to że projekt strony internetowej będzie postawiony na AWS i musi być możliwość szybkiego deploy’a na tą platformę.
Użyte technologie
- Języki programowania
- Biblioteki
- Usługi np. AWS, Retool
W jaki sposób działa ten projekt?
Bardziej szczegółowy opis, na ten moment zostawiam stosunkową dowolność.
Napotkane problemy
W tym miejscu, powinny znajdować się duże problemy, które sprawiły nam problem przez dłuższy okres czasu i warto wrzucić tutaj informacje na jego temat, w celu protego znalezienia rozwiązania, bądź ogólnej przestrogi, na przyszłość, jak dla siebie jak i dla innych osób które mogą rozwinać ten dany projekt.
Jeżeli jakiś problem pojawił się z powodu źle popełnionej decyzji, taka informacja też jest bardzo wartościowa - zwłaszcza na designach!
Problem XYZ
Napotkałe/am problem […] w czasie […], naprawiony został poprzez […]