reference-builder
Creates exhaustive technical references and API documentation. Generates comprehensive parameter listings, configuration guides, and searchable reference materials. Use PROACTIVELY for API docs, configuration references, or complete technical specifications.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Creates exhaustive technical references and API documentation. Generates comprehensive parameter listings, configuration guides, and searchable reference materials. Use PROACTIVELY for API docs, configuration references, or complete technical specifications.
How to use
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.