readme-generate
Automatycznie generuj dokumentację README dla modułów Spring Boot
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność do szybkiego tworzenia kompleksowych plików README.md dla projektów Spring Boot. Analizuje strukturę modułu i generuje dokumentację zawierającą opis funkcjonalności, dokumentację API, przykłady użycia, wytyczne testowania i ważne uwagi. Idealna do utrzymania spójnej dokumentacji w wielu modułach i automatyzacji tworzenia dokumentacji dla nowych komponentów.
Jak używać
Przygotuj ścieżkę do modułu Spring Boot, dla którego chcesz wygenerować README — na przykład basic/chat lub basic/tool.
Uruchom skrypt generatora z linii poleceń, podając ścieżkę modułu jako parametr obowiązkowy: python .claude/skills/readme-generate/scripts/readme_generator.py ścieżka_do_modułu
Plik README.md zostanie automatycznie utworzony w katalogu modułu (domyślna lokalizacja to {ścieżka_modułu}/README.md).
Jeśli chcesz zapisać dokumentację w innym miejscu, dodaj opcjonalny parametr z niestandardową ścieżką wyjściową: python .claude/skills/readme-generate/scripts/readme_generator.py ścieżka_do_modułu nazwa_pliku.md
Wygenerowana dokumentacja będzie zawierać opis funkcjonalności, dokumentację interfejsów API, przykłady użycia oraz wytyczne testowania — wszystko zgodnie ze specyfikacją zadania.
Możesz uruchomić generator ponownie dla tego samego modułu, aby zaktualizować README gdy zmieni się zawartość modułu.