Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do tworzenia wyczerpujących dokumentacji technicznych i referencji API. Automatycznie generuje listy parametrów, przewodniki konfiguracji i materiały referencyjne przeszukiwalne dla zespołu. Idealne do dokumentowania każdego parametru, metody i opcji konfiguracyjnej — od sygnatury funkcji po obsługę błędów i limity wydajności. Oszczędza czas przy tworzeniu dokumentacji, którą zespół będzie rzeczywiście używać.
Jak używać
Zainstaluj skill reference-builder w swoim środowisku Claude/Copilot, wskazując repozytorium https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/reference-builder jako źródło.
Przygotuj materiały wejściowe: zbierz wszystkie parametry API, opcje konfiguracyjne, schematy danych lub specyfikacje techniczne, które chcesz udokumentować. Jasno określ cel dokumentacji (np. "dokumentacja API REST dla systemu płatności") i ograniczenia (np. "tylko publiczne endpointy").
Uruchom skill z pytaniem o konkretny typ referencji: API reference (sygnatury metod, typy zwracane, kody błędów, limity), configuration guide (parametry, wartości domyślne, zależności) lub schema documentation (typy pól, reguły walidacji, relacje).
Skill wygeneruje wyczerpującą dokumentację z kategoryzacją, przykładami dla każdej funkcji i dokumentacją przypadków granicznych. Zweryfikuj, czy wszystkie parametry są uwzględnione i czy organizacja odpowiada potrzebom zespołu.
Jeśli potrzebujesz szczegółowych przykładów implementacji, otwórz plik resources/implementation-playbook.md z repozytorium, aby uzyskać dodatkowe wskazówki i wzorce.
Opublikuj wygenerowaną dokumentację w systemie, który zespół będzie regularnie sprawdzać — dokumentacja działa tylko wtedy, gdy jest łatwo dostępna i przeszukiwalna.