codebase-onboarding
Automatyczne dokumenty onboardingowe z analizy kodu — dla nowych zespołów i kontrahentów
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność analizuje strukturę repozytorium i generuje dokumentację onboardingową dostosowaną do roli nowego członka zespołu. Odkrywa architekturę, identyfikuje kluczowe pliki konfiguracyjne, tworzy instrukcje setup i listy kontrolne dla deweloperów, tech leadów i kontrahentów. Przydatna przy wprowadzaniu nowych osób, przebudowie dokumentacji po refaktoryzacji lub przygotowaniu pakietu handoff dla usług.
Jak używać
Przygotuj ścieżkę do repozytorium, które chcesz przeanalizować. Upewnij się, że masz dostęp do plików projektu na lokalnym dysku.
Uruchom skrypt analizatora kodu: python3 scripts/codebase_analyzer.py /ścieżka/do/repo — narzędzie przeskanuje strukturę, wykryje języki programowania, pliki konfiguracyjne i główne katalogi.
Jeśli potrzebujesz wyniku w formacie JSON do dalszego przetwarzania, dodaj flagę --json: python3 scripts/codebase_analyzer.py /ścieżka/do/repo --json
Otwórz szablon dokumentacji w references/onboarding-template.md i uzupełnij go danymi zebranymi w kroku 2. Szablon zawiera sekcje dla architektury, instrukcji setup i checklist'y.
Dostosuj głębokość dokumentacji do odbiorcy: dla juniora dodaj szczegóły setup i wytyczne bezpieczeństwa, dla seniora — zagadnienia architektoniczne i operacyjne, dla kontrahenta — zakres odpowiedzialności i granice integracji.
Zweryfikuj wszystkie komendy setup na czystym środowisku przed udostępnieniem dokumentacji nowemu członkowi zespołu.