wiki-onboarding

Umiejętność tworzy cztery kompleksowe dokumenty onboardingu dostosowane do potrzeb różnych stanowisk — od nowych współpracowników po dyrektorów. Każdy przewodnik zawiera dokładnie te informacje, które dana rola potrzebuje, aby szybko zrozumieć architekturę i pracować z kodem. Dokumenty generowane są w strukturze folderów z linkami do repozytorium i cytowaniami linii kodu.

1. Uruchom umiejętność w kontekście repozytorium, które chcesz udokumentować — może to być lokalne repozytorium Git lub projekt z dostępnym URL-em. 2. Umiejętność najpierw sprawdzi, czy istnieje zdalne repozytorium, uruchamiając git remote get-url origin. Jeśli repozytorium jest tylko lokalne, poinformuj o tym umiejętność. 3. Umiejętność określi domyślną gałąź projektu i przygotuje się do generowania dokumentów. 4. Otrzymasz folder onboarding/ zawierający cztery pliki: index.md (strona główna z linkami), contributor-guide.md (dla nowych współpracowników), staff-engineer-guide.md (dla inżynierów), executive-guide.md (dla kierownictwa) i product-manager-guide.md (dla menedżerów produktu). 5. Każdy przewodnik zawiera cytowania do konkretnych linii kodu w repozytorium — jeśli masz URL, będą to linki klikalne; jeśli pracujesz lokalnie, będą to ścieżki do plików. 6. Rozpowszechniaj przewodniki wśród zespołu — każda osoba otrzyma dokładnie to, co powinna wiedzieć o projekcie.