Witaj w repozytorium dokumentacji naszego projektu! Aby zapewnić spójność i efektywność pracy, stworzyliśmy ten krótki przewodnik dotyczący korzystania z GitHub Pages oraz struktury naszego repozytorium. Znajdziesz tu niezbędne informacje o plikach i folderach, oraz jak efektywnie nimi zarządzać.
Repozytorium zostało podzielne na kilka kluczowych sekcji:
/docs- Główny folder zawierający dokumentację projektu./Architecture- Dokumentacja architektoniczna projektu, w tymiteracja1.mdopisująca początkową strukturę./Wytyczne dla ról- Wytyczne dla różnych zespołów projektowych./Wymagania- Wymagania projektowe, w tymiteracja1.mdz wymaganiami dla pierwszej iteracji./Narzędzia- Opis narzędzi wykorzystywanych w projekcie
Architektura.md- Podsumowanie architektury projektu.Wytyczne dla ról.md- Ogólne wytyczne dla zespołu.Wymagania.md- Podsumowanie wymagań projektowych.Narzędzia.md- Podsumowanie narzędzi używanych w projekcie.index.md- Strona główna dokumentacji projektu na GitHub Pages.
-
Aktualizacja Dokumentacji: Gdy pracujesz nad dokumentacją, pamiętaj o dodawaniu zmian do odpowiednich plików w folderze
/docs. Zachowaj spójność formatowania i terminologii. -
Dodawanie Nowych Plików: Jeśli musisz dodać nowy dokument, umieść go w odpowiednim folderze w zależności od jego kategorii. Upewnij się, że nazwa pliku jasno wskazuje na jego zawartość.
-
Współpraca: Korzystaj z funkcji pull requestów (PR) do wprowadzania większych zmian. Daje to innym członkom zespołu możliwość przeglądu i komentarza przed scaleniem zmian.
-
GitHub Pages: Aby zaktualizować naszą stronę GitHub Pages, wystarczy zpushować zmiany do brancha
main. Automatycznie zostanie wygenerowana aktualna wersja dokumentacji oparta o pliki markdown w folderze/docs.
Pamiętaj, że jasna i aktualna dokumentacja jest kluczowa dla sukcesu naszego projektu. Dziękujemy za twoją współpracę i wkład w utrzymanie porządku w naszym repozytorium GitHub Pages!