W
wiki-onboarding
Generates two complementary onboarding guides — a Principal-Level architectural deep-dive and a Zero-to-Hero contributor walkthrough. Use when the user wants onboarding documentation for a codebase.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Generates two complementary onboarding guides — a Principal-Level architectural deep-dive and a Zero-to-Hero contributor walkthrough. Use when the user wants onboarding documentation for a codebase.
How to use
- 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 folderonboarding/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) iproduct-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.