Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do tworzenia profesjonalnej dokumentacji technicznej na podstawie kodu źródłowego. Generuje przegląd projektu, dokumentację API z parametrami i przykładami, instrukcje konfiguracji oraz wzorce użycia. Idealny dla deweloperów, którzy chcą zaoszczędzić czas na pisaniu dokumentacji i zapewnić jej spójność z kodem. Wykorzystuje jasny język, pracujące przykłady i strukturę ułatwiającą wyszukiwanie.
Jak używać
Zainstaluj skill doc-gen w swoim środowisku Claude/Copilot, wskazując repozytorium phodal/auto-dev.
Przygotuj kod, dla którego chcesz wygenerować dokumentację — skill będzie analizować jego strukturę, metody i funkcjonalność.
Uruchom skill, przekazując ścieżkę do projektu lub kodu jako argument. Skill automatycznie wczyta nazwę projektu i kontekst.
Skill wygeneruje dokumentację w czterech sekcjach: Overview (cel, przypadki użycia, kluczowe cechy), API Documentation (metody, parametry, zwracane wartości, przykłady), Code Examples (podstawowe użycie, popularne wzorce, zaawansowane scenariusze) oraz Configuration (ustawienia, wartości domyślne, zmienne środowiskowe).
Przejrzyj wygenerowaną dokumentację — jest napisana prostym, zrozumiałym językiem z działającymi przykładami kodu, gotowa do publikacji lub dalszych edycji.
Opcjonalnie dostosuj strukturę lub dodaj szczegóły specyficzne dla Twojego projektu — skill stanowi solidną bazę, którą możesz rozbudować.