code-documentation
Generuj profesjonalną dokumentację kodu – README, API docs i komentarze inline
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność do tworzenia efektywnej dokumentacji technicznej dla swoich projektów. Generuje strukturalne pliki README z sekcjami Quick Start i Installation, dokumentację API w stylu JSDoc/TSDoc z parametrami i przykładami, oraz przewodniki dla developerów. Idealna dla zespołów chcących szybko dokumentować kodbase, API czy biblioteki bez ręcznego pisania każdej sekcji od zera.
Jak używać
Zainstaluj umiejętność w swoim agencie AI, dodając ją do konfiguracji skills. Upewnij się, że masz dostęp do repozytorium projektu lub kodu, który chcesz dokumentować.
Przygotuj informacje o projekcie: nazwę, krótki opis funkcjonalności, instrukcje instalacji (np. npm install) i przykłady użycia kodu, które chcesz uwzględnić w dokumentacji.
Użyj umiejętności do wygenerowania strukturalnego pliku README. Skill automatycznie utworzy sekcje takie jak Quick Start, Installation, Usage i API Reference na podstawie szablonu.
Dla dokumentacji API wygeneruj komentarze JSDoc/TSDoc do swoich funkcji. Podaj parametry, typy zwracane, możliwe błędy i przykłady użycia – skill sformatuje je zgodnie ze standardem.
Jeśli dokumentujesz API REST, użyj generatora do utworzenia specyfikacji OpenAPI/Swagger. Skill pomoże zorganizować endpointy, parametry i odpowiedzi w czytelnym formacie.
Przejrzyj wygenerowaną dokumentację, dostosuj opisy do swoich potrzeb i umieść pliki w repozytorium projektu.