Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność do automatycznego tworzenia i aktualizacji pliku README.md dla Twojego projektu. Generuje szczegółową dokumentację obejmującą konfigurację lokalnego środowiska, architekturę systemu i instrukcje wdrażania. Aktywuj ją, gdy chcesz napisać readme, udokumentować projekt lub poprosić o pomoc z dokumentacją. Narzędzie analizuje strukturę kodu, pliki konfiguracyjne, bazę danych i przepływy CI/CD, aby stworzyć dokumentację na poziomie profesjonalnym.
Jak używać
Wyzwól umiejętność, pisząc do asystenta: "napisz readme", "utwórz dokumentację projektu" lub "pomóż mi z README.md". Możesz też powiedzieć "dokumentuj ten projekt" lub "project documentation".
Umiejętność przeanalizuje strukturę Twojego repozytorium — przeszuka katalogi, pliki konfiguracyjne (.env, docker-compose.yml, Dockerfile), schemat bazy danych (db/schema.rb) i pliki CI/CD (.github/workflows).
Zidentyfikuje główny punkt wejścia aplikacji, framework (Rails, Node.js, Go, Python) i sposób wdrażania (Kamal, Fly.io, Render, Heroku).
Wygeneruje README zawierające trzy sekcje: instrukcje uruchomienia lokalnego, szczegółowe wyjaśnienie architektury systemu oraz kroki do wdrożenia w produkcji.
Przejrzyj wygenerowaną dokumentację i dostosuj ją do specyfiki Twojego projektu — dodaj lub usuń sekcje zależnie od potrzeb.
Zapisz plik README.md w głównym katalogu repozytorium i zatwierdź zmiany w kontroli wersji.