S
smart-docs
Generuj profesjonalną dokumentację kodu za pomocą AI — analizuj architekturę, twórz diagramy C4 i specyfikacje techniczne.
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do automatycznego generowania kompleksowej dokumentacji projektów. Analizuje strukturę kodu, rozpoznaje wzorce architektoniczne, tworzy diagramy C4 w Mermaid i produkuje profesjonalne dokumenty techniczne. Obsługuje wszystkie języki programowania. Pracuje natywnie z Claude Code bez dodatkowych kosztów API — alternatywa dla Litho/deepwiki-rs. Idealna dla zespołów, które muszą szybko udokumentować istniejące kodebazy lub zrozumieć złożoną architekturę oprogramowania.
Jak używać
- Zainstaluj skill smart-docs w swoim środowisku Claude Code, upewniając się, że masz dostęp do narzędzi Read, Glob, Write i Bash (tree, find, wc, cloc).
- Przygotuj projekt do analizy — umieść go w dostępnym katalogu i upewnij się, że możesz uruchomić polecenia powłoki w jego głównym folderze.
- Uruchom fazę odkrywania projektu, prosząc skill o przeanalizowanie struktury katalogów (np. za pomocą tree -L 3 z wyłączeniami node_modules, target, build) i policzenie linii kodu (cloc lub find z wc).
- Pozwól skillowi zidentyfikować punkty wejścia, zależności i stos technologiczny na podstawie plików konfiguracyjnych i struktury katalogów.
- Poproś o wygenerowanie dokumentacji zgodnie z modelem C4 — skill utworzy diagramy Mermaid dla każdego poziomu (kontekst, kontenery, komponenty) i markdown z opisami architektonicznymi.
- Przejrzyj wygenerowane pliki markdown i diagramy, a następnie poproś o dostosowania — skill może regenerować sekcje, dodawać przykłady kodu lub rozszerzać specyficzne moduły.