codebase-documenter
Generates comprehensive documentation explaining how a codebase works, including architecture, key components, data flow, and development guidelines. Use when user wants to understand unfamiliar code, create onboarding docs, document architecture, or explain how the system works.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Generates comprehensive documentation explaining how a codebase works, including architecture, key components, data flow, and development guidelines. Use when user wants to understand unfamiliar code, create onboarding docs, document architecture, or explain how the system works.
How to use
Zainstaluj skill codebase-documenter w swoim środowisku Claude lub kompatybilnym narzędziu AI obsługującym skills.
Przygotuj dostęp do swojej bazy kodu – upewnij się, że możesz udostępnić pliki, strukturę katalogów i repozytorium narzędziu.
Uruchom skill z poleceniem opisującym, co chcesz udokumentować. Użyj jednej z sugerowanych fraz: "wyjaśnij tę bazę kodu", "dokumentuj architekturę", "jak działa ten kod", "utwórz dokumentację dla deweloperów" lub "wygeneruj przegląd bazy kodu".
Skill automatycznie eksploruje Twoją bazę kodu, analizując strukturę projektu, komponenty, przepływy danych i integracje. Proces obejmuje mapowanie katalogów, identyfikację kluczowych modułów i zrozumienie zależności.
Otrzymasz kompleksową dokumentację zawierającą przegląd projektu, diagramy architektury (w formacie Mermaid), opis struktury katalogów, dokumentację komponentów, instrukcje konfiguracji oraz wytyczne dla zespołu.
Wykorzystaj wygenerowaną dokumentację do onboardingu nowych członków zespołu, dokumentacji decyzji architektonicznych lub jako punkt wyjścia do dalszych ulepszeń dokumentacji.