Witamy w dokumentacji projektu Sharebee.
To miejsce stanowi centralne repozytorium wiedzy o projekcie – zarówno dla obecnych członków zespołu, jak i dla osób, które dołączą w przyszłości.
Celem tej wiki jest zebranie w jednym miejscu wszystkich informacji potrzebnych do zrozumienia, rozwijania oraz utrzymywania projektu. Dokumentacja powinna być aktualizowana na bieżąco wraz z rozwojem systemu.
Wiki projektu ma na celu:
Dobrze utrzymywana dokumentacja pozwala uniknąć utraty wiedzy projektowej oraz znacząco skraca czas potrzebny na rozwiązywanie problemów.
Cała dokumentacja została podzielona na kategorie tematyczne, które pozwalają łatwo odnaleźć potrzebne informacje. W miarę rozwoju projektu mogą pojawiać się nowe sekcje.
Aby dokumentacja była użyteczna i spójna, warto stosować kilka zasad:
1. Aktualność
Dokumentacja powinna być aktualizowana razem z wprowadzaniem zmian w projekcie.
2. Jedno źródło prawdy
Wiki powinna być głównym miejscem przechowywania wiedzy projektowej.
3. Jasność i prostota
Dokumenty powinny być pisane w sposób czytelny i zrozumiały.
4. Struktura
Każdy dokument powinien posiadać:
5. Diagramy i przykłady
Warto dodawać:
Wiki jest przeznaczona dla:
Korzystaj z kategorii, aby szybko odnaleźć informacje.
Jeśli dokument nie istnieje — utwórz go.
Jeśli dokument jest nieaktualny — zaktualizuj go.
Staraj się dokumentować wszystkie istotne decyzje projektowe.
Dokumentacja projektu będzie rozwijać się razem z projektem Sharebee.
Z czasem pojawią się tu bardziej szczegółowe opisy komponentów, architektury, infrastruktury oraz procedur operacyjnych.
Wiki powinna być traktowana jako żywy dokument, który ewoluuje razem z systemem.