Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill analizuje strukturę kodu, wzorce projektowe i decyzje architektoniczne, aby automatycznie tworzyć obszerną dokumentację techniczną i e-booki. Idealne do tworzenia podręczników systemowych, przewodników architektonicznych i szczegółowych analiz technicznych. Oszczędza czas na ręcznym dokumentowaniu złożonych systemów poprzez inteligentne wyodrębnianie informacji z codebase'u.
Jak używać
Przygotuj dostęp do repozytorium kodu, który chcesz zdokumentować. Skill będzie analizować strukturę folderów, zależności między modułami i wzorce implementacyjne.
Wyjaśnij cele dokumentacji — czy potrzebujesz przewodnika architektonicznego, podręcznika dla nowych deweloperów, czy e-booka z deep-dive'em technicznym. Określ docelową publiczność i poziom szczegółowości.
Skill przeanalizuje codebase w fazie odkrywania: zidentyfikuje kluczowe komponenty, ich relacje, przepływy danych i punkty integracji. Wyodrębni decyzje architektoniczne i zastosowane wzorce projektowe.
W fazie strukturyzacji skill zaproponuje hierarchię rozdziałów i sekcji, planując progresywne ujawnianie złożoności. Zasugeruje diagramy, schematy i materiały wizualne niezbędne do zrozumienia systemu.
Skill wygeneruje dokumentację w fazie pisania, zaczynając od streszczenia wykonawczego i przeglądu ogólnego, następnie przechodząc do szczegółowych wyjaśnień. Zapewni spójną terminologię i jasne wyjaśnienia dla różnych poziomów zaawansowania czytelnika.
Zweryfikuj wygenerowaną dokumentację pod kątem dokładności i kompletności. Jeśli potrzebujesz szczegółowych przykładów implementacyjnych, skill może odwołać się do playbooka w
resources/implementation-playbook.md.