api-reference-creator
Automatyczne tworzenie dokumentacji API — umów się na precyzyjne referencje techniczne
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do automatycznego generowania dokumentacji referencyjnej API. Aktywuje się na żądanie i wspomaga tworzenie kompletnych dokumentów technicznych — od opisów endpointów po schematy danych. Wykorzystuje narzędzia do odczytu, edycji i walidacji plików, aby dostarczyć gotową do produkcji dokumentację zgodną ze standardami branżowymi. Idealny dla zespołów, które chcą przyspieszyć proces dokumentowania interfejsów API.
Jak używać
Wyzwól skill, wpisując w swoim żądaniu frazę "api reference creator" lub pytając o pomoc z tworzeniem dokumentacji API — skill aktywuje się automatycznie.
Opisz API, które chcesz udokumentować: podaj listę endpointów, parametry, typy odpowiedzi oraz przykłady użycia. Im więcej szczegółów, tym dokładniejsza będzie wygenerowana dokumentacja.
Skill przeanalizuje Twoje dane i wygeneruje strukturę dokumentacji referencyjnej, uwzględniając najlepsze praktyki branżowe — takie jak jasne nazewnictwo, spójne formatowanie i kompletne opisy parametrów.
Przejrzyj wygenerowaną dokumentację i wskaż ewentualne poprawki — skill umożliwia edycję i dostosowanie treści do Twoich potrzeb.
Skill waliduje finalny dokument pod kątem zgodności ze standardami technicznymi, a następnie zapisuje go w wybranym formacie (Markdown, HTML lub inny).
Wykorzystaj gotową dokumentację API w swoim projekcie — dokumentacja jest gotowa do publikacji i integracji z systemami dokumentacji (np. Swagger, ReadTheDocs).