Toolverse
All skills

codebase-onboarding

by alirezarezvani

Codebase Onboarding

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Category
Backend
Views
20

About this skill

Codebase Onboarding

How to use

  1. Przygotuj ścieżkę do repozytorium, które chcesz przeanalizować. Upewnij się, że masz dostęp do plików projektu na lokalnym dysku.

  2. 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.

  3. Jeśli potrzebujesz wyniku w formacie JSON do dalszego przetwarzania, dodaj flagę --json: python3 scripts/codebase_analyzer.py /ścieżka/do/repo --json

  4. 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.

  5. 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.

  6. Zweryfikuj wszystkie komendy setup na czystym środowisku przed udostępnieniem dokumentacji nowemu członkowi zespołu.

Related skills