smart-docs

AI-powered comprehensive codebase documentation generator. Analyzes project structure, identifies architecture patterns, creates C4 model diagrams, and generates professional technical documentation. Use when users need to document codebases, understand software architecture, create technical specs, or generate developer guides. Supports all programming languages. Alternative to Litho/deepwiki-rs that uses Claude Code subscription without external API costs.

1. 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).
2. 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.
3. 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).
4. Pozwól skillowi zidentyfikować punkty wejścia, zależności i stos technologiczny na podstawie plików konfiguracyjnych i struktury katalogów.
5. Poproś o wygenerowanie dokumentacji zgodnie z modelem C4 — skill utworzy diagramy Mermaid dla każdego poziomu (kontekst, kontenery, komponenty) i markdown z opisami architektonicznymi.
6. 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.